MDJM REST API: Availability

The MDJM REST API includes the /availability/ endpoint to enable availability look ups to be performed.

The /availability/ endpoint allows you to query the events and availability database to determine if you are available on the given date.

Parameters

The /availability/ endpoint requires a single parameter to be sent along with the API request. There are also additional parameters than can optionally be provided;

• date (Required)
  The date for which to perform the availability lookup. Should be provided in the format Y-m-d i.e. 2016-07-18
• employees (Optional)
  Comma separated list of employees to perform the lookup on. Default to all
• roles (Optional)
  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;

• date (string)
  The which was checked
• response (string)
  available if the agency is available in the given date, or unavailable
• employees (string)
  Comma separated list of employees who are available on the given date
• message (string)
  Relevant available/unavailable response as defined within MDJM->Settings->Client Zone Settings->Availability Checker

Method

The /availability/ endpoint accepts the GET HTTP method only.

[heading element=”h3″ style=”bordered” remove_margins=”top,bottom”]Security[/heading]

The /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;

http://<yoursite.com>/wp-json/mdjm/v1/availability/?date=2016-07-18

Response

The response from the above query would look like;

{
    "data": {
        "availability": {
            "date": "2016-07-19",
            "response": "available",
            "employees": [
                18,
                1
            ],
            "message": "Good news, we are available on the date you entered. Please contact us now"
        }
    },
    "headers": {
        "Content-type": "application/json"
    },
    "status": 200
}