/availability/ endpoint allows you to query the events and availability database to determine if you are available on the given date.
/availability/ endpoint requires a single parameter to be sent along with the API request. There are also additional parameters than can optionally be provided;
The date for which to perform the availability lookup. Should be provided in the format Y-m-d i.e. 2016-07-18
Comma separated list of employees to perform the lookup on. Default to all
Comma separated list of role slugs to perform the lookup on. Default to those set within MDJM -> Settings -> Client Zone -> Availability Settings
The following details will be returned;
The which was checked
available if the agency is available in the given date, or unavailable
Comma separated list of employees who are available on the given date
Relevant available/unavailable response as defined within MDJM->Settings->Client Zone Settings->Availability Checker
/availability/ endpoint accepts the GET HTTP method only.
/availability/ endpoint requires no security validation and therefore it is not necessary to send the API key or Token with the request.
Example API Call
To retrieve availability information for 18th July, 2016 the following would be used;
The response from the above query would look like;
"message": "Good news, we are available on the date you entered. Please contact us now"
Rate this Article
We're working hard to ensure we provide you with useful and relevant documentation to help you get the most out of MDJM Event Management.
Please take a moment to let us know if you found this article helpful.