Lavanda Developer API
API change historyLavanda Developer API
Request
Request URL
Request parameters
-
(optional)string
Return tasks belonging to a property
-
(optional)string
Format - YYYY-MM-DD. Format - YYYY-MM-DD. Format - YYYY-MM-DD. Format - YYYY-MM-DD. Format - YYYY-MM-DD. Format - YYYY-MM-DD. Format - YYYY-MM-DD. Return tasks since a given date
-
(optional)string
Format - YYYY-MM-DD. Format - YYYY-MM-DD. Format - YYYY-MM-DD. Format - YYYY-MM-DD. Format - YYYY-MM-DD. Format - YYYY-MM-DD. Format - YYYY-MM-DD. Return tasks up until a given date
-
(optional)integer
Number of tasks returned per page. Maximum and default value of 50 records
-
(optional)string
Cursor-based pagination that identifies the last record of the previous page - Can be retrieved at 'meta[page][next]' and it's not the same value as the record ID
-
(optional)string
DEPRECATED: limit param is deprecated. Prefer using 'page[size]' param instead
Request headers
Request body
Responses
200 OK
Success
Representations
{
"data": [
{
"id": "S_QQXOBApfZi3IeDh3SW5MkDu2IDrfEkk2pP_cOPKnw",
"type": "task",
"attributes": {
"category": "Guest Ready Clean",
"description": null,
"status": "in_progress",
"system_generated": false,
"title": "Task 11",
"urgent": false,
"created_at": "2019-11-20T00:00:00Z",
"date": "2019-11-20",
"estimated_time_in_hours": 2,
"updated_at": "2019-11-20T00:00:00Z"
},
"relationships": {
"assignee_one": {
"data": {
"id": "uddvcSG_4SFWAU1rB9fN8vDt7Ei8Tg9V28Z6pPORY2k",
"type": "user"
}
},
"assignee_two": {
"data": {
"id": "WuthaZOHeJwp93nnz6EUE425auirteB33U3aHZdenew",
"type": "user"
}
},
"property": {
"data": {
"id": "HA2fgMd2a0Bg_SBjibEjawThokqYFXBtMzLL01D9AbA",
"type": "property"
}
},
"media_items": {
"data": [
{
"id": "2bOdlIY20pHZLvUYDSq4ud7C5WJD261nkc9xBr5EjKI",
"type": "media_item"
}
]
}
}
}
],
"included": [
{
"id": "2bOdlIY20pHZLvUYDSq4ud7C5WJD261nkc9xBr5EjKI",
"type": "media_item",
"attributes": {
"media_source": "cloudinary",
"media_type": "image",
"name": "4f78304b41e16b92ad66ac5222e45830",
"ref": "ops/e09ade201874dd286c753455e06786f9"
}
},
{
"id": "uddvcSG_4SFWAU1rB9fN8vDt7Ei8Tg9V28Z6pPORY2k",
"type": "user",
"attributes": {
"email": "user_47@test.com",
"name": "User 47"
}
},
{
"id": "WuthaZOHeJwp93nnz6EUE425auirteB33U3aHZdenew",
"type": "user",
"attributes": {
"email": "user_48@test.com",
"name": "User 48"
}
}
],
"meta": {
"page": {
"total": 1,
"number": 1,
"next": null
},
"records": {
"number": 1,
"total": 1
}
}
}{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"category": {
"type": "string",
"enum": [
"Ad Hoc Owner Refund",
"Check In",
"Churn Clean",
"Claim",
"Coordinate",
"Guest Ready Clean",
"Inform Guest",
"Inform Owner",
"Maintenance Quote",
"Maintenance Visit",
"Mid Stay Clean",
"Onboard Clean",
"Onboarding Visit",
"Owner Credit",
"Owner Leaving Clean",
"Owner Return Check Clean",
"Owner Return Clean",
"Pro Photography Visit",
"Purchase",
"Refresh Clean",
"Refund",
"Runner Visit",
"Scheduling Request",
"Spring Clean",
"Update Pricing",
"Update Property Info",
"Valuation"
]
},
"status": {
"type": "string",
"enum": [
"new",
"in_progress",
"resolved",
"complete",
"closed"
]
},
"date": {
"type": "string",
"format": "YYYY-MM-DD"
},
"estimated_time_in_hours": {
"type": "number",
"x-nullable": true
},
"description": {
"type": "string",
"x-nullable": true
},
"system_generated": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"urgent": {
"type": "boolean"
}
}
},
"relationships": {
"type": "object",
"properties": {
"property": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
},
"assignee_one": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
},
"assignee_two": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
},
"media_items": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"page": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"number": {
"type": "number"
},
"next": {
"type": "string",
"x-nullable": true
}
}
},
"records": {
"type": "object",
"properties": {
"number": {
"type": "number"
},
"total": {
"type": "number"
}
}
}
}
},
"included": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
},
"attributes": {
"type": "object"
}
}
}
}
}
}400 Bad Request
Bad request
Representations
{
"errors": [
{
"detail": "string"
}
]
}{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"detail": {
"type": "string"
}
}
}
}
}
}401 Unauthorized
Unauthorized
Representations
403 Forbidden
Forbidden
Representations
500 Internal Server Error
Server error
Representations
Code samples
@ECHO OFF
curl -v -X GET "https://lavanda.azure-api.net/tasks?property_id={string}&start_date={string}&end_date={string}&page[size]={integer}&page[after]={string}&limit={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["property_id"] = "{string}";
queryString["start_date"] = "{string}";
queryString["end_date"] = "{string}";
queryString["page[size]"] = "{integer}";
queryString["page[after]"] = "{string}";
queryString["limit"] = "{string}";
var uri = "https://lavanda.azure-api.net/tasks?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://lavanda.azure-api.net/tasks");
builder.setParameter("property_id", "{string}");
builder.setParameter("start_date", "{string}");
builder.setParameter("end_date", "{string}");
builder.setParameter("page[size]", "{integer}");
builder.setParameter("page[after]", "{string}");
builder.setParameter("limit", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"property_id": "{string}",
"start_date": "{string}",
"end_date": "{string}",
"page[size]": "{integer}",
"page[after]": "{string}",
"limit": "{string}",
};
$.ajax({
url: "https://lavanda.azure-api.net/tasks?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://lavanda.azure-api.net/tasks";
NSArray* array = @[
// Request parameters
@"entities=true",
@"property_id={string}",
@"start_date={string}",
@"end_date={string}",
@"page[size]={integer}",
@"page[after]={string}",
@"limit={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://lavanda.azure-api.net/tasks');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'property_id' => '{string}',
'start_date' => '{string}',
'end_date' => '{string}',
'page[size]' => '{integer}',
'page[after]' => '{string}',
'limit' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'property_id': '{string}',
'start_date': '{string}',
'end_date': '{string}',
'page[size]': '{integer}',
'page[after]': '{string}',
'limit': '{string}',
})
try:
conn = httplib.HTTPSConnection('lavanda.azure-api.net')
conn.request("GET", "/tasks?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'property_id': '{string}',
'start_date': '{string}',
'end_date': '{string}',
'page[size]': '{integer}',
'page[after]': '{string}',
'limit': '{string}',
})
try:
conn = http.client.HTTPSConnection('lavanda.azure-api.net')
conn.request("GET", "/tasks?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://lavanda.azure-api.net/tasks')
query = URI.encode_www_form({
# Request parameters
'property_id' => '{string}',
'start_date' => '{string}',
'end_date' => '{string}',
'page[size]' => '{integer}',
'page[after]' => '{string}',
'limit' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body