Lavanda Developer API

API change history

Update a task

Try it

Request

Request URL

https://lavanda.azure-api.net/tasks/{id}

Request parameters

id

string

Request headers

Content-Type (optional)

string

Media type of the body sent to the API.
Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.

Request body

application/json

Sample
Schema

{
  "task": {
    "category": "Ad Hoc Owner Refund",
    "status": "new",
    "date": "string",
    "title": "string",
    "property_id": "string",
    "assigned_to": "string",
    "assigned_to_2": "string",
    "description": "string",
    "estimated_time_in_hours": 0,
    "urgent": true
  }
}

{
  "type": "object",
  "required": [
    "task"
  ],
  "properties": {
    "task": {
      "type": "object",
      "properties": {
        "category": {
          "type": "string",
          "description": "The category of the task",
          "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",
          "description": "The status of the task",
          "enum": [
            "new",
            "in_progress",
            "resolved",
            "complete",
            "closed"
          ]
        },
        "date": {
          "type": "string",
          "description": "The date that the task is due to be carried out",
          "format": "YYYY-MM-DD"
        },
        "title": {
          "type": "string",
          "description": "The title of the task"
        },
        "property_id": {
          "type": "string",
          "description": "The ID of the associated property"
        },
        "assigned_to": {
          "type": "string",
          "description": "The ID of the first user assigned to the task"
        },
        "assigned_to_2": {
          "type": "string",
          "description": "The ID of the second user assigned to the task"
        },
        "description": {
          "type": "string",
          "description": "The description of the task"
        },
        "estimated_time_in_hours": {
          "type": "number",
          "description": "The housekeeping units of the task",
          "format": "integer"
        },
        "urgent": {
          "type": "boolean",
          "description": "The urgency of the task"
        }
      }
    }
  },
  "example": {
    "task": {
      "category": "Ad Hoc Owner Refund",
      "status": "new",
      "date": "string",
      "title": "string",
      "property_id": "string",
      "assigned_to": "string",
      "assigned_to_2": "string",
      "description": "string",
      "estimated_time_in_hours": 0,
      "urgent": true
    }
  }
}

Responses

200 OK

Success

Representations

application/json

Sample
Schema

{
  "data": {
    "id": "1fQV_dsDwHoM9H5rIKNlvVK_9wzid1Dpi62lKSG5aeY",
    "type": "task",
    "attributes": {
      "category": "Check In",
      "description": "A description",
      "status": "new",
      "system_generated": false,
      "title": "Title",
      "urgent": false,
      "created_at": "2019-11-20T00:00:00Z",
      "date": "2019-11-01",
      "estimated_time_in_hours": 1,
      "updated_at": "2019-11-20T00:00:00Z"
    },
    "relationships": {
      "assignee_one": {
        "data": {
          "id": "hmywzDqtOZ3H3bLKIIBbOD9y0Y46gyF8k4PDxBvt7Xg",
          "type": "user"
        }
      },
      "assignee_two": {
        "data": {
          "id": "J9jZlXkzZrADXv9dbSqb5nNV9F6yIr29z1p9svfnHbs",
          "type": "user"
        }
      },
      "property": {
        "data": {
          "id": "26RWqLctlO1wb4sdZMKdAkaxHYLDZua-JX6U2UyuyyU",
          "type": "property"
        }
      },
      "media_items": {
        "data": [
          {
            "id": "O9xfAXVe_Q_hOixeVlup50AkdfzWGlohF3Vrbkhp_wg",
            "type": "media_item"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "O9xfAXVe_Q_hOixeVlup50AkdfzWGlohF3Vrbkhp_wg",
      "type": "media_item",
      "attributes": {
        "media_source": "cloudinary",
        "media_type": "image",
        "name": "b09fb6e4400d2b8dc1ed378722b32965",
        "ref": "ops/5aeac34dc56083c3b13717bec9a18e1e"
      }
    },
    {
      "id": "hmywzDqtOZ3H3bLKIIBbOD9y0Y46gyF8k4PDxBvt7Xg",
      "type": "user",
      "attributes": {
        "email": "user_33@test.com",
        "name": "User 33"
      }
    },
    {
      "id": "J9jZlXkzZrADXv9dbSqb5nNV9F6yIr29z1p9svfnHbs",
      "type": "user",
      "attributes": {
        "email": "user_34@test.com",
        "name": "User 34"
      }
    }
  ]
}

{
  "type": "object",
  "properties": {
    "data": {
      "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"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "included": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "attributes": {
            "type": "object"
          }
        }
      }
    }
  }
}

400 Bad Request

Bad request

Representations

application/json

Sample
Schema

{
  "errors": [
    {
      "detail": "string"
    }
  ]
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "detail": {
            "type": "string"
          }
        }
      }
    }
  }
}

401 Unauthorized

Unauthorized

Representations

application/json

403 Forbidden

Forbidden

Representations

application/json

500 Internal Server Error

Server error

Representations

application/json

Code samples

@ECHO OFF

curl -v -X PATCH "https://lavanda.azure-api.net/tasks/{id}"
-H "Content-Type: application/json"
-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}");

            var uri = "https://lavanda.azure-api.net/tasks/{id}?" + queryString;

        }
    }
}

// // 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/{id}");


            URI uri = builder.build();
            HttpPatch request = new HttpPatch(uri);
            request.setHeader("Content-Type", "application/json");
            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
        };
      
        $.ajax({
            url: "https://lavanda.azure-api.net/tasks/{id}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PATCH",
            // 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/{id}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PATCH"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_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/{id}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PATCH);

// 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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('lavanda.azure-api.net')
    conn.request("PATCH", "/tasks/{id}?%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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('lavanda.azure-api.net')
    conn.request("PATCH", "/tasks/{id}?%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/{id}')


request = Net::HTTP::Patch.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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