Digital-Nautic API: Resource

Methods

get - get resource
get - List resources (paginated)

Resource

{
    "boatId": "integer",
    "characteristics": [
        {
            "comment": "string",
            "familyName": "string",
            "id": "integer",
            "key": "string",
            "name": "string",
            "unit": "string",
            "value": "string"
        }
    ],
    "company": {
        "addressCity": {
            "administrativeAreaLevel2": {
                "administrativeAreaLevel1": {
                    "country": {
                        "code": "string",
                        "name": "string"
                    },
                    "id": "integer",
                    "name": "string"
                },
                "id": "integer",
                "name": "string"
            },
            "id": "integer",
            "latitude": "number",
            "longitude": "number",
            "name": "string",
            "navigationArea": {
                "country": {
                    "code": "string",
                    "name": "string"
                },
                "id": "integer",
                "name": "string"
            },
            "postalCode": "string"
        },
        "addressPostalCode": "string",
        "addressStreet1": "string",
        "addressStreet2": "string",
        "companyBrandName": "string",
        "companyContactEmail": "email",
        "companyContactPhone": {},
        "companyLegalForm": {
            "id": "integer",
            "name": "string"
        },
        "companyLegalReason": "string",
        "companyLogo": "string",
        "companySiretNumber": "string",
        "companyVatNumber": "string",
        "companyWebsiteUrl": "uri",
        "id": "integer"
    },
    "creationDatetime": "date-time",
    "description": "string",
    "durations": [
        {
            "type": "string",
            "value": "string"
        }
    ],
    "equipments": [
        {
            "comment": "string",
            "familyName": "string",
            "id": "integer",
            "key": "string",
            "name": "string",
            "unit": "string",
            "value": "string"
        }
    ],
    "harbour": {
        "city": {
            "administrativeAreaLevel2": {
                "administrativeAreaLevel1": {
                    "country": {
                        "code": "string",
                        "name": "string"
                    },
                    "id": "integer",
                    "name": "string"
                },
                "id": "integer",
                "name": "string"
            },
            "id": "integer",
            "latitude": "number",
            "longitude": "number",
            "name": "string",
            "navigationArea": {
                "country": {
                    "code": "string",
                    "name": "string"
                },
                "id": "integer",
                "name": "string"
            },
            "postalCode": "string"
        },
        "id": "integer",
        "latitude": "number",
        "longitude": "number",
        "name": "string"
    },
    "id": "string",
    "images": {
        "cover": {
            "large": {
                "height": "integer",
                "uri": "uri",
                "width": "integer"
            },
            "medium": {
                "height": "integer",
                "uri": "uri",
                "width": "integer"
            },
            "original": {
                "height": "integer",
                "uri": "uri",
                "width": "integer"
            },
            "small": {
                "height": "integer",
                "uri": "uri",
                "width": "integer"
            }
        },
        "others": [
            {
                "large": {
                    "height": "integer",
                    "uri": "uri",
                    "width": "integer"
                },
                "medium": {
                    "height": "integer",
                    "uri": "uri",
                    "width": "integer"
                },
                "original": {
                    "height": "integer",
                    "uri": "uri",
                    "width": "integer"
                },
                "small": {
                    "height": "integer",
                    "uri": "uri",
                    "width": "integer"
                }
            }
        ]
    },
    "isLicenseMandatory": "boolean",
    "isRentable": "boolean",
    "isSkipperAvailable": "boolean",
    "isSkipperMandatory": "boolean",
    "lastModificationDatetime": "date-time",
    "minPrice": "number",
    "name": "string",
    "version": {
        "description": "string",
        "id": "integer",
        "images": {
            "cover": {
                "large": {
                    "height": "integer",
                    "uri": "uri",
                    "width": "integer"
                },
                "medium": {
                    "height": "integer",
                    "uri": "uri",
                    "width": "integer"
                },
                "original": {
                    "height": "integer",
                    "uri": "uri",
                    "width": "integer"
                },
                "small": {
                    "height": "integer",
                    "uri": "uri",
                    "width": "integer"
                }
            },
            "others": [
                {
                    "large": {
                        "height": "integer",
                        "uri": "uri",
                        "width": "integer"
                    },
                    "medium": {
                        "height": "integer",
                        "uri": "uri",
                        "width": "integer"
                    },
                    "original": {
                        "height": "integer",
                        "uri": "uri",
                        "width": "integer"
                    },
                    "small": {
                        "height": "integer",
                        "uri": "uri",
                        "width": "integer"
                    }
                }
            ]
        },
        "model": {
            "description": "string",
            "id": "integer",
            "name": "string",
            "range": {
                "builder": {
                    "description": "string",
                    "id": "integer",
                    "name": "string"
                },
                "description": "string",
                "id": "integer",
                "name": "string"
            }
        },
        "name": "string",
        "subtype": {
            "description": "string",
            "id": "integer",
            "name": "string",
            "type": {
                "description": "string",
                "id": "integer",
                "name": "string"
            }
        }
    }
}

Properties

Name	Type	Description	Additional
boatId	integer	Boat ID - Deprecated for the use of the full resourceId format (see changelog)	Optional, read only.
characteristics[]	array	Characteristics available on the resource	Optional, read only.
characteristics[].comment	string	Additional comment	Optional, read only.
characteristics[].familyName	string	Characteristic family/group name	Optional, read only.
characteristics[].id	integer	Characteristic ID	Optional, read only.
characteristics[].key	string	Unique code which identify the characteristic	Optional, read only.
characteristics[].name	string	Characteristic name	Optional, read only.
characteristics[].unit	string	Unit of the characteristic (accepted values are QUANTITY, METRE, HORSEPOWER, LITRE, WEIGHT, SPEED)	Optional, read only.
characteristics[].value	string	Value of the characteristic	Optional, read only.
company	object		Optional, read only.
company.addressCity	object		Optional, read only.
company.addressCity.administrativeAreaLevel2	object		Optional, read only.
company.addressCity.administrativeAreaLevel2.administrativeAreaLevel1	object		Optional, read only.
company.addressCity.administrativeAreaLevel2.administrativeAreaLevel1.country	object		Optional, read only.
company.addressCity.administrativeAreaLevel2.administrativeAreaLevel1.country.code	string	Country code	Optional, read only.
company.addressCity.administrativeAreaLevel2.administrativeAreaLevel1.country.name	string	Country name	Optional, read only.
company.addressCity.administrativeAreaLevel2.administrativeAreaLevel1.id	integer	Administrative area level 1 ID	Optional, read only.
company.addressCity.administrativeAreaLevel2.administrativeAreaLevel1.name	string	Administrative area level 1 name	Optional, read only.
company.addressCity.administrativeAreaLevel2.id	integer	Administrative area level 2 ID	Optional, read only.
company.addressCity.administrativeAreaLevel2.name	string	Administrative area level 2 name	Optional, read only.
company.addressCity.id	integer	City ID	Optional, read only.
company.addressCity.latitude	number	Geographical latitude of the city position	Optional, read only.
company.addressCity.longitude	number	Geographical longitude of the city position	Optional, read only.
company.addressCity.name	string	City name	Optional, read only.
company.addressCity.navigationArea	object		Optional, read only.
company.addressCity.navigationArea.country	object		Optional, read only.
company.addressCity.navigationArea.country.code	string	Country code	Optional, read only.
company.addressCity.navigationArea.country.name	string	Country name	Optional, read only.
company.addressCity.navigationArea.id	integer	Navigation area ID	Optional, read only.
company.addressCity.navigationArea.name	string	Navigation area name	Optional, read only.
company.addressCity.postalCode	string	City postal code	Optional, read only.
company.addressPostalCode	string	Postal code	Optional, read only.
company.addressStreet1	string	Address street 1	Optional, read only.
company.addressStreet2	string	Address street 2	Optional, read only.
company.companyBrandName	string	Brand name	Optional, read only.
company.companyContactEmail	email	Contact Email	Optional, read only.
company.companyContactPhone	object		Optional, read only.
company.companyLegalForm	object	Company type	Optional
company.companyLegalForm.id	integer	Element ID	Optional, read only.
company.companyLegalForm.name	string	Legal form name	Optional, read only.
company.companyLegalReason	string	Legal reason	Optional, read only.
company.companyLogo	string	Logo file path	Optional, read only.
company.companySiretNumber	string	Siret number	Optional, read only.
company.companyVatNumber	string	Vat identification number	Optional, read only.
company.companyWebsiteUrl	uri	Website Url	Optional, read only.
company.id	integer	Company ID.	Optional, read only.
creationDatetime	date-time	Resource creation date-time	Optional, read only.
description	string	Product description.	Optional, read only.
durations[]	array	Durations available when renting the resource	Optional, read only.
durations[].type	string	Rental duration type (accepted values are MINUTES, PERIODS, DAYS, WEEKS)	Optional, read only.
durations[].value	string	Rental duration value (accepted values are periods like MORNING, AFTERNOON, EVENING or a number)	Optional, read only.
equipments[]	array	Equipments available on the resource	Optional, read only.
equipments[].comment	string	Additional comment	Optional, read only.
equipments[].familyName	string	Characteristic family/group name	Optional, read only.
equipments[].id	integer	Equipment ID	Optional, read only.
equipments[].key	string	Unique code which identifies the equipment	Optional, read only.
equipments[].name	string	Characteristic name	Optional, read only.
equipments[].unit	string	Unit of the equipment (accepted values are QUANTITY, METRE, HORSEPOWER, LITRE, WEIGHT, SPEED)	Optional, read only.
equipments[].value	string	Value of the equipment	Optional, read only.
harbour	object		Optional, read only.
harbour.city	object		Optional, read only.
harbour.city.administrativeAreaLevel2	object		Optional, read only.
harbour.city.administrativeAreaLevel2.administrativeAreaLevel1	object		Optional, read only.
harbour.city.administrativeAreaLevel2.administrativeAreaLevel1.country	object		Optional, read only.
harbour.city.administrativeAreaLevel2.administrativeAreaLevel1.country.code	string	Country code	Optional, read only.
harbour.city.administrativeAreaLevel2.administrativeAreaLevel1.country.name	string	Country name	Optional, read only.
harbour.city.administrativeAreaLevel2.administrativeAreaLevel1.id	integer	Administrative area level 1 ID	Optional, read only.
harbour.city.administrativeAreaLevel2.administrativeAreaLevel1.name	string	Administrative area level 1 name	Optional, read only.
harbour.city.administrativeAreaLevel2.id	integer	Administrative area level 2 ID	Optional, read only.
harbour.city.administrativeAreaLevel2.name	string	Administrative area level 2 name	Optional, read only.
harbour.city.id	integer	City ID	Optional, read only.
harbour.city.latitude	number	Geographical latitude of the city position	Optional, read only.
harbour.city.longitude	number	Geographical longitude of the city position	Optional, read only.
harbour.city.name	string	City name	Optional, read only.
harbour.city.navigationArea	object		Optional, read only.
harbour.city.navigationArea.country	object		Optional, read only.
harbour.city.navigationArea.country.code	string	Country code	Optional, read only.
harbour.city.navigationArea.country.name	string	Country name	Optional, read only.
harbour.city.navigationArea.id	integer	Navigation area ID	Optional, read only.
harbour.city.navigationArea.name	string	Navigation area name	Optional, read only.
harbour.city.postalCode	string	City postal code	Optional, read only.
harbour.id	integer	Harbour ID	Optional, read only.
harbour.latitude	number	Geographical latitude of the harbour position	Optional, read only.
harbour.longitude	number	Geographical longitude of the harbour position	Optional, read only.
harbour.name	string	Harbour name	Optional, read only.
id	string	Resource ID	Optional, read only.
images	object		Optional, read only.
images.cover	object	Boat photo.	Optional
images.cover.large	object	Boat photo details.	Optional
images.cover.large.height	integer	Photo item height (in pixels)	Optional, read only.
images.cover.large.uri	uri	Photo item path	Optional, read only.
images.cover.large.width	integer	Photo item width (in pixels)	Optional, read only.
images.cover.medium	object	Boat photo details.	Optional
images.cover.medium.height	integer	Photo item height (in pixels)	Optional, read only.
images.cover.medium.uri	uri	Photo item path	Optional, read only.
images.cover.medium.width	integer	Photo item width (in pixels)	Optional, read only.
images.cover.original	object	Boat photo details.	Optional
images.cover.original.height	integer	Photo item height (in pixels)	Optional, read only.
images.cover.original.uri	uri	Photo item path	Optional, read only.
images.cover.original.width	integer	Photo item width (in pixels)	Optional, read only.
images.cover.small	object	Boat photo details.	Optional
images.cover.small.height	integer	Photo item height (in pixels)	Optional, read only.
images.cover.small.uri	uri	Photo item path	Optional, read only.
images.cover.small.width	integer	Photo item width (in pixels)	Optional, read only.
images.others[]	array		Optional
images.others[].large	object	Boat photo details.	Optional
images.others[].large.height	integer	Photo item height (in pixels)	Optional, read only.
images.others[].large.uri	uri	Photo item path	Optional, read only.
images.others[].large.width	integer	Photo item width (in pixels)	Optional, read only.
images.others[].medium	object	Boat photo details.	Optional
images.others[].medium.height	integer	Photo item height (in pixels)	Optional, read only.
images.others[].medium.uri	uri	Photo item path	Optional, read only.
images.others[].medium.width	integer	Photo item width (in pixels)	Optional, read only.
images.others[].original	object	Boat photo details.	Optional
images.others[].original.height	integer	Photo item height (in pixels)	Optional, read only.
images.others[].original.uri	uri	Photo item path	Optional, read only.
images.others[].original.width	integer	Photo item width (in pixels)	Optional, read only.
images.others[].small	object	Boat photo details.	Optional
images.others[].small.height	integer	Photo item height (in pixels)	Optional, read only.
images.others[].small.uri	uri	Photo item path	Optional, read only.
images.others[].small.width	integer	Photo item width (in pixels)	Optional, read only.
isLicenseMandatory	boolean	Returns TRUE, if the boat license is mandatory	Optional, read only.
isRentable	boolean	Returns TRUE, if the resource is available for rental	Optional, read only.
isSkipperAvailable	boolean	Returns TRUE, if a skipper is available	Optional, read only.
isSkipperMandatory	boolean	Returns TRUE, if the skipper is mandatory	Optional, read only.
lastModificationDatetime	date-time	Resource last update date-time	Optional, read only.
minPrice	number	Minimum rental price. The rental price may differ depending to the rental duration.	Optional, read only.
name	string	Boat name	Optional, read only.
version	object		Optional, read only.
version.description	string	Version description	Optional
version.id	integer	Version ID	Optional, read only.
version.images	object	Boat photo album. Contains the cover photo, as well as additional photos.	Optional
version.images.cover	object	Boat photo.	Optional
version.images.cover.large	object	Boat photo details.	Optional
version.images.cover.large.height	integer	Photo item height (in pixels)	Optional, read only.
version.images.cover.large.uri	uri	Photo item path	Optional, read only.
version.images.cover.large.width	integer	Photo item width (in pixels)	Optional, read only.
version.images.cover.medium	object	Boat photo details.	Optional
version.images.cover.medium.height	integer	Photo item height (in pixels)	Optional, read only.
version.images.cover.medium.uri	uri	Photo item path	Optional, read only.
version.images.cover.medium.width	integer	Photo item width (in pixels)	Optional, read only.
version.images.cover.original	object	Boat photo details.	Optional
version.images.cover.original.height	integer	Photo item height (in pixels)	Optional, read only.
version.images.cover.original.uri	uri	Photo item path	Optional, read only.
version.images.cover.original.width	integer	Photo item width (in pixels)	Optional, read only.
version.images.cover.small	object	Boat photo details.	Optional
version.images.cover.small.height	integer	Photo item height (in pixels)	Optional, read only.
version.images.cover.small.uri	uri	Photo item path	Optional, read only.
version.images.cover.small.width	integer	Photo item width (in pixels)	Optional, read only.
version.images.others[]	array		Optional
version.images.others[].large	object	Boat photo details.	Optional
version.images.others[].large.height	integer	Photo item height (in pixels)	Optional, read only.
version.images.others[].large.uri	uri	Photo item path	Optional, read only.
version.images.others[].large.width	integer	Photo item width (in pixels)	Optional, read only.
version.images.others[].medium	object	Boat photo details.	Optional
version.images.others[].medium.height	integer	Photo item height (in pixels)	Optional, read only.
version.images.others[].medium.uri	uri	Photo item path	Optional, read only.
version.images.others[].medium.width	integer	Photo item width (in pixels)	Optional, read only.
version.images.others[].original	object	Boat photo details.	Optional
version.images.others[].original.height	integer	Photo item height (in pixels)	Optional, read only.
version.images.others[].original.uri	uri	Photo item path	Optional, read only.
version.images.others[].original.width	integer	Photo item width (in pixels)	Optional, read only.
version.images.others[].small	object	Boat photo details.	Optional
version.images.others[].small.height	integer	Photo item height (in pixels)	Optional, read only.
version.images.others[].small.uri	uri	Photo item path	Optional, read only.
version.images.others[].small.width	integer	Photo item width (in pixels)	Optional, read only.
version.model	object	Boat model information	Optional
version.model.description	string	Model description	Optional
version.model.id	integer	Model ID	Optional, read only.
version.model.name	string	Model name	Optional
version.model.range	object	Boat range information	Optional
version.model.range.builder	object	Boat builder	Optional
version.model.range.builder.description	string	Builder description	Optional
version.model.range.builder.id	integer	Builder ID	Optional, read only.
version.model.range.builder.name	string	Builder name	Optional
version.model.range.description	string	Range description	Optional
version.model.range.id	integer	Range ID	Optional, read only.
version.model.range.name	string	Range name	Optional
version.name	string	Version name	Optional
version.subtype	object	Boat type	Optional
version.subtype.description	string	Subtype description	Optional
version.subtype.id	integer	Subtype ID	Optional, read only.
version.subtype.name	string	Subtype name	Optional
version.subtype.type	object	Boat type	Optional
version.subtype.type.description	string	Type description	Optional
version.subtype.type.id	integer	Type ID	Optional, read only.
version.subtype.type.name	string	Type name	Optional

Resource resource

Methods

Resource

Properties