Digital-Nautic API: Rental

Methods

get - Get rental
post - Initiate the rental process
get - List rentals (paginated)
put - Update rental

Resource

{
    "arrivalDatetime": "date-time",
    "arrivalHarbour": {
        "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"
    },
    "commissionPrice": "number",
    "contractLink": "string",
    "creationDatetime": "date-time",
    "crewAdults": "integer",
    "crewChildren": "integer",
    "departureDatetime": "date-time",
    "departureHarbour": {
        "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"
    },
    "depositCurrency": {},
    "depositPrice": "number",
    "depositStatus": "string",
    "discountPrice": "number",
    "id": "integer",
    "lastModificationDatetime": "date-time",
    "message": "string",
    "orderLink": "string",
    "paymentProgress": "integer",
    "referenceId": "string",
    "rentalPrice": "number",
    "status": "string",
    "totalPaid": "number",
    "totalToPay": "number",
    "user": {
        "addressCity": "string",
        "addressCountry": {
            "code": "string",
            "name": "string"
        },
        "addressPostalCode": "string",
        "addressState": "string",
        "addressStreet1": "string",
        "addressStreet2": "string",
        "birthDate": "date",
        "civility": "string",
        "creationDatetime": "date-time",
        "deactivated": "boolean",
        "email": "email",
        "firstName": "string",
        "id": "integer",
        "landlinePhone": "string",
        "language": {
            "code": "string",
            "name": "string"
        },
        "lastModificationDatetime": "date-time",
        "lastName": "string",
        "mobilePhone": "string",
        "nationality": {
            "code": "string",
            "name": "string"
        },
        "organizationName": "string",
        "organizationType": "string",
        "organizationVatNumber": "string"
    }
}

Properties

Name	Type	Description	Additional
arrivalDatetime	date-time	Rental arrival date-time	Optional, read only.
arrivalHarbour	object		Optional, read only.
arrivalHarbour.city	object		Optional, read only.
arrivalHarbour.city.administrativeAreaLevel2	object		Optional, read only.
arrivalHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1	object		Optional, read only.
arrivalHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1.country	object		Optional, read only.
arrivalHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1.country.code	string	Country code	Optional, read only.
arrivalHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1.country.name	string	Country name	Optional, read only.
arrivalHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1.id	integer	Administrative area level 1 ID	Optional, read only.
arrivalHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1.name	string	Administrative area level 1 name	Optional, read only.
arrivalHarbour.city.administrativeAreaLevel2.id	integer	Administrative area level 2 ID	Optional, read only.
arrivalHarbour.city.administrativeAreaLevel2.name	string	Administrative area level 2 name	Optional, read only.
arrivalHarbour.city.id	integer	City ID	Optional, read only.
arrivalHarbour.city.latitude	number	Geographical latitude of the city position	Optional, read only.
arrivalHarbour.city.longitude	number	Geographical longitude of the city position	Optional, read only.
arrivalHarbour.city.name	string	City name	Optional, read only.
arrivalHarbour.city.navigationArea	object		Optional, read only.
arrivalHarbour.city.navigationArea.country	object		Optional, read only.
arrivalHarbour.city.navigationArea.country.code	string	Country code	Optional, read only.
arrivalHarbour.city.navigationArea.country.name	string	Country name	Optional, read only.
arrivalHarbour.city.navigationArea.id	integer	Navigation area ID	Optional, read only.
arrivalHarbour.city.navigationArea.name	string	Navigation area name	Optional, read only.
arrivalHarbour.city.postalCode	string	City postal code	Optional, read only.
arrivalHarbour.id	integer	Harbour ID	Optional, read only.
arrivalHarbour.latitude	number	Geographical latitude of the harbour position	Optional, read only.
arrivalHarbour.longitude	number	Geographical longitude of the harbour position	Optional, read only.
arrivalHarbour.name	string	Harbour name	Optional, read only.
commissionPrice	number	How much you've taken as a commission	Optional
contractLink	string	A link to the rental contract in your system	Optional
creationDatetime	date-time	Rental creation date-time	Optional, read only.
crewAdults	integer	Number of adults	Optional, read only.
crewChildren	integer	Number of children	Optional, read only.
departureDatetime	date-time	Rental departure date-time	Optional, read only.
departureHarbour	object		Optional, read only.
departureHarbour.city	object		Optional, read only.
departureHarbour.city.administrativeAreaLevel2	object		Optional, read only.
departureHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1	object		Optional, read only.
departureHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1.country	object		Optional, read only.
departureHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1.country.code	string	Country code	Optional, read only.
departureHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1.country.name	string	Country name	Optional, read only.
departureHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1.id	integer	Administrative area level 1 ID	Optional, read only.
departureHarbour.city.administrativeAreaLevel2.administrativeAreaLevel1.name	string	Administrative area level 1 name	Optional, read only.
departureHarbour.city.administrativeAreaLevel2.id	integer	Administrative area level 2 ID	Optional, read only.
departureHarbour.city.administrativeAreaLevel2.name	string	Administrative area level 2 name	Optional, read only.
departureHarbour.city.id	integer	City ID	Optional, read only.
departureHarbour.city.latitude	number	Geographical latitude of the city position	Optional, read only.
departureHarbour.city.longitude	number	Geographical longitude of the city position	Optional, read only.
departureHarbour.city.name	string	City name	Optional, read only.
departureHarbour.city.navigationArea	object		Optional, read only.
departureHarbour.city.navigationArea.country	object		Optional, read only.
departureHarbour.city.navigationArea.country.code	string	Country code	Optional, read only.
departureHarbour.city.navigationArea.country.name	string	Country name	Optional, read only.
departureHarbour.city.navigationArea.id	integer	Navigation area ID	Optional, read only.
departureHarbour.city.navigationArea.name	string	Navigation area name	Optional, read only.
departureHarbour.city.postalCode	string	City postal code	Optional, read only.
departureHarbour.id	integer	Harbour ID	Optional, read only.
departureHarbour.latitude	number	Geographical latitude of the harbour position	Optional, read only.
departureHarbour.longitude	number	Geographical longitude of the harbour position	Optional, read only.
departureHarbour.name	string	Harbour name	Optional, read only.
depositCurrency	object		Optional, read only.
depositPrice	number	Deposit price to let by the customer before starting the rental	Optional, read only.
depositStatus	string	The deposit can have multiple status depending of the company usages (accepted values as PENDING, RECEIVED, KEPT, RETURNED)	Optional, read only.
discountPrice	number	The price for a discount. If not specified, will be zero	Optional
id	integer	Rental ID	Optional, read only.
lastModificationDatetime	date-time	Rental last update date-time	Optional, read only.
message	string	Client message dedicated to the company	Optional, read only.
orderLink	string	A link to the Rental in your system	Optional
paymentProgress	integer	Payment progress = amount paid on the total to pay	Optional, read only.
referenceId	string	A reference ID to the Rental in your system	Optional
rentalPrice	number	The price for the rental. It does not apply to the products. If not specified, the initial price will be defined.	Optional
status	string	Rental status (accepted values as VALIDATED, CANCELED_BY_CLIENT, CANCELED_BAD_WEATHER, CANCELED_BREAKDOWN, CANCELED_PAYMENT)	Optional
totalPaid	number	Amount already paid	Optional, read only.
totalToPay	number	Total amount to pay	Optional, read only.
user	object		Optional, read only.
user.addressCity	string	User city of residence
user.addressCountry	object	Country information.
user.addressCountry.code	string	Country code	Optional, read only.
user.addressCountry.name	string	Country name	Optional, read only.
user.addressPostalCode	string	User postal code of residence
user.addressState	string	User state of residence
user.addressStreet1	string	User address street 1 of residence
user.addressStreet2	string	User address street 2 of residence	Optional
user.birthDate	date	User date of birth
user.civility	string	User civility (accepted values are MS, MR, OTHER)
user.creationDatetime	date-time	User creation date-time	Optional, read only.
user.deactivated	boolean	TRUE if a profile is deactivated or blocked.	Optional, read only.
user.email	email	User email
user.firstName	string	User first name
user.id	integer	User ID	Optional, read only.
user.landlinePhone	string	Phone
user.language	object	User language
user.language.code	string	Standard language code
user.language.name	string	Language name
user.lastModificationDatetime	date-time	User last update date-time	Optional, read only.
user.lastName	string	User last name
user.mobilePhone	string	Phone
user.nationality	object	Country information.
user.nationality.code	string	Country code	Optional, read only.
user.nationality.name	string	Country name	Optional, read only.
user.organizationName	string	Organization name. Necessary if the user represents an association or a society	Optional
user.organizationType	string	User can be an individual or can represent an association or a society (accepted values are INDIVIDUAL, SOCIETY, ASSOCIATION)
user.organizationVatNumber	string	Organization VAT number. Necessary if the user represents an association or a society	Optional

Rental resource

Methods

Resource

Properties