Get the resource availability. The result informs the min rental duration and the min rental delay of the resource. It also tells if a slot is available for the given date and duration with a min price.

Request

GET https://api.digital-nautic.com/v3/resources/{resourceId}/availability

Path parameters

Parameter name Value Description Additional
resourceId string

pass a mandatory resource id to get access to the availability

Required

Query parameters

Parameter name Value Description Additional
date date

pass a mandatory date to get the resource availability

Required
duration string

pass a mandatory duration to get the resource availability. The regex is the following => /^(MINUTES,[1-9]{3}|PERIODS,[MORNING|AFTERNOON]|DAYS,[1-6]|WEEKS,[1-4]|DATE,([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])))$

Required
test boolean

set to true to return test resources

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

found item

Resource Availability
400 Bad Request

invalid input, object invalid

401 Unauthorized

authorization information is missing or invalid.

404 Not Found

a resource with the specified ID was not found.


Explore this API

resourceId

pass a mandatory resource id to get access to the availability

date

pass a mandatory date to get the resource availability

duration

pass a mandatory duration to get the resource availability. The regex is the following => /^(MINUTES,[1-9]{3}|PERIODS,[MORNING|AFTERNOON]|DAYS,[1-6]|WEEKS,[1-4]|DATE,([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])))$

test

set to true to return test resources

Response Content-Type
Try it out!