Digital-Nautic API: Specification summary

User management

Operation	HTTP Request	Description
delete	DELETE /v3/users/{userId}	Delete a user from your addressbook
get	GET /v3/users/{userId}	Get a user from your addressbook
put	PUT /v3/users/{userId}	Update a user from your addressbook
get	GET /v3/users	List users in your addressbook (paginated)
post	POST /v3/users	Add a new user to your addressbook

User documents management

Operation	HTTP Request	Description
delete	DELETE /v3/users/{userId}/identity	Delete identity document for an existing user
get	GET /v3/users/{userId}/identity	Get a user's identity document
post	POST /v3/users/{userId}/identity	Add identity document to an existing user
put	PUT /v3/users/{userId}/identity	Update identity document for an existing user
delete	DELETE /v3/users/{userId}/license	Delete license document for an existing user
get	GET /v3/users/{userId}/license	Get a user's license document
post	POST /v3/users/{userId}/license	Add license document to an existing user
put	PUT /v3/users/{userId}/license	Update license document for an existing user

Retrieve company details

Operation	HTTP Request	Description
get	GET /v3/companies/{companyId}	Get company
get	GET /v3/companies	List companies (paginated)

Retrieve resource details

Operation	HTTP Request	Description
get	GET /v3/resources/{resourceId}/durations	Get resource durations
get	GET /v3/resources/{resourceId}/pricetable	Get the resource pricetable
get	GET /v3/resources/{resourceId}/pricings	Get resource pricings
get	GET /v3/resources/{resourceId}	get resource
get	GET /v3/resources	List resources (paginated)

Retrieve resource option details

Operation	HTTP Request	Description
get	GET /v3/resources/{resourceId}/options/{optionId}	Get resource option
get	GET /v3/resources/{resourceId}/options	List resource options

Retrieve resource availability details

Operation	HTTP Request	Description
get	GET /v3/resources/availabilities	Get resources availabilities
get	GET /v3/resources/{resourceId}/availabilities	Get resource availabilities
get	GET /v3/resources/{resourceId}/availability	Get resource availability
get	GET /v3/resources/{resourceId}/unavailabilities	Get resource unavailabilities

Retrieve resource slot details

Operation	HTTP Request	Description
get	GET /v3/resources/{resourceId}/slots/{slotId}/options	Get slot options
get	GET /v3/resources/{resourceId}/slots/{slotId}/tides	Get slot tides
get	GET /v3/resources/{resourceId}/slots	List resource slots

Rental management

Operation	HTTP Request	Description
delete	DELETE /v3/rentals/{rentalId}	Delete rental
get	GET /v3/rentals/{rentalId}	Get rental
put	PUT /v3/rentals/{rentalId}	Update rental
get	GET /v3/rentals	List rentals (paginated)
post	POST /v3/rentals	Initiate the rental process

Rental resource management

Operation	HTTP Request	Description
get	GET /v3/rentals/{rentalId}/resource	Get rental resource

Rental option management

Operation	HTTP Request	Description
delete	DELETE /v3/rentals/{rentalId}/options/{optionId}	Remove option from rental
get	GET /v3/rentals/{rentalId}/options/{optionId}	Get rental option
put	PUT /v3/rentals/{rentalId}/options/{optionId}	Change rental option quantity
get	GET /v3/rentals/{rentalId}/options	List rental options
post	POST /v3/rentals/{rentalId}/options	Add an option to a rental

Rental payment management

Operation	HTTP Request	Description
delete	DELETE /v3/rentals/{rentalId}/payments/{paymentId}	Remove rental payment line
get	GET /v3/rentals/{rentalId}/payments/{paymentId}	Get rental payment line
put	PUT /v3/rentals/{rentalId}/payments/{paymentId}	Update rental payment line
get	GET /v3/rentals/{rentalId}/payments	List rental payment lines
post	POST /v3/rentals/{rentalId}/payments	Add payment line to a rental

Rental user management

Operation	HTTP Request	Description
get	GET /v3/rentals/{rentalId}/user	Get rental user
post	POST /v3/rentals/{rentalId}/user	Assign a user to a rental

Rental crew management

Operation	HTTP Request	Description
delete	DELETE /v3/rentals/{rentalId}/crewMembers/{crewMemberId}	Delete rental crew member
get	GET /v3/rentals/{rentalId}/crewMembers/{crewMemberId}	Get crew member details
put	PUT /v3/rentals/{rentalId}/crewMembers/{crewMemberId}	Update rental crew member
get	GET /v3/rentals/{rentalId}/crewMembers	List rental crew members
post	POST /v3/rentals/{rentalId}/crewMembers	Add a crew member to a rental

Geographical data

Operation	HTTP Request	Description
get	GET /v3/administrativeAreaLevel1/{administrativeAreaLevel1Id}	Get administrative area of level 1
get	GET /v3/administrativeAreaLevel1	List administrative areas of level 1
get	GET /v3/administrativeAreaLevel2/{administrativeAreaLevel2Id}	Get administrative area of level 2
get	GET /v3/administrativeAreaLevel2	List administrative areas of level 2
get	GET /v3/cities/{cityId}	Get city
get	GET /v3/cities	List cities
get	GET /v3/countries/{countryCode}	Get country
get	GET /v3/countries	List countries
get	GET /v3/harbours/{harbourId}	Get harbour
get	GET /v3/harbours	List harbours
get	GET /v3/navigationAreas/{navigationAreaId}	Get navigation area
get	GET /v3/navigationAreas	List navigation areas

Miscellaneous data

Operation	HTTP Request	Description
get	GET /v3/characteristics/{characteristicId}	Get resource characteristic
get	GET /v3/characteristics	List resource characteristics
get	GET /v3/companyLegalForms/{companyLegalFormId}	Get company legal form
get	GET /v3/companyLegalForms	List company legal forms
get	GET /v3/equipments/{equipmentId}	Get resource equipment
get	GET /v3/equipments	List resource equipments
get	GET /v3/rentalPaymentMethods/{rentalPaymentId}	Get rental payment method
get	GET /v3/rentalPaymentMethods	List available rental payment methods
get	GET /v3/subtypes/{subtypeId}	Get resource subtype
get	GET /v3/subtypes	List resource subtypes
get	GET /v3/types/{typeId}	Get resource type
get	GET /v3/types	List resource types
get	GET /v3/userLicenseTypes/{userLicenseTypeId}	Get user license type
get	GET /v3/userLicenseTypes	List user license types