Landlords FSO API Documentation

Overview

Things that the developers should know about

Authentication

What is the preferred way of using the API?

Error Codes

What errors and status codes can a user expect?

Rate limit

Is there a limit to the number of requests an user can send?

 

GEToverviewProperty

https://landlordsfso.co.uk/api/properties/overviewProperty/[key]/[format]/[ID]

Data about a specific property within the Landlords Fso system

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

[ID]  = Id of the request made.


    $curl = curl_init();

  curl_setopt_array($curl, array(
    CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/overviewProperty/[key]/[type]/[ID]",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
  ));

  $response = curl_exec($curl);
  $err = curl_error($curl);

  curl_close($curl);

  if ($err) {
    echo "cURL Error #:" . $err;
  } else {
    echo $response;
  }
 

GETListProperties

https://landlordsfso.co.uk/api/properties/listProperties/[key]/[format]

List all the properties within the landlords system.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.


    $curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/listProperties/[key]/[type]",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Cache-Control: no-cache",
    "Postman-Token: 4af56e61-80c4-46d2-a2fb-aaf85fc2b3d4"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETlistCounties

https://landlordsfso.co.uk/api/properties/listCounties/[key]/[type]/

For ease of the user. A list of known counties which can be passed when editing or creating a property.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/listCounties/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETlistCounties

https://landlordsfso.co.uk/api/properties/listCounties/[key]/[type]/

For ease of the user. A list of known counties which can be passed when editing or creating a property.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/listCounties/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETcheckTypes

https://landlordsfso.co.uk/api/properties/checkTypes/[key]/[type]/

A list of the options that can be chosen in 6 month or yearly checks.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/checkTypes/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETdownloadMonthlyCheck

https://landlordsfso.co.uk/api/properties/downloadMonthlyCheck/[key]/[ID]

Download a monthly check as a pdf

[key] = customers API key located in the accounts section within the dashboard.

[ID]  = Report Id of the request made. 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/downloadMonthlyCheck/[key]/[ID]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETfireRisk

https://landlordsfso.co.uk/api/properties/fireRisk/[key]/[type]/[ID]?page=2

List fo firerisk reports. add a property id to the end to see a particular property. This dataset will be provided in pagination, simply append the page to the url.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

[ID]  = Id of the request made.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/fireRisk/[key]/[type]/[ID]?page=2",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETmonthlyChecks

https://landlordsfso.double-click.co.uk/api/properties/monthlyChecks/[key]/[type]/

Get a list of monthly checks add a property id to list the properties monthly checks.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/monthlyChecks/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETsixMonthlyChecks

https://landlordsfso.double-click.co.uk/api/properties/sixMonthlyChecks/[key]/[type]/?page=3

Six monthly checks

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/sixMonthlyChecks/[key]/[type]/?page=3",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETyearlyChecks

https://landlordsfso.co.uk/api/properties/yearlyChecks/[key]/[type]/

Get a list of the yearly fire risk assesments checks to be done on a yearly basis.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.double-click.co.uk/api/properties/yearlyChecks/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETfiveYearlyChecks

https://landlordsfsoco.uk/api/properties/fiveYearlyChecks/[key]/[type]/

Get a list of the five yearly fire risk assesments checks to be done on a yearly basis.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfsoco.uk/api/properties/fiveYearlyChecks/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETviewMonthlyReport

https://landlordsfso.double-click.co.uk/api/properties/viewMonthlyReport/[key]/[type]/[ID]

View a 6 monthly report.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

[ID]  = Id of the request made.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/viewMonthlyReport/[key]/[type]/[ID]",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETviewSixMonthlyReport

https://landlordsfso.co.uk/api/properties/viewSixMonthlyReport/[key]/[type]/[ID/

View a six monthly report from the Landlords Fso System.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

[ID]  = Id of the request made.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/viewSixMonthlyReport/[key]/[type]/[ID/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETviewYearlyReport

https://landlordsfso.co.uk/api/properties/viewYearlyReport/[key]/[type]/[ID]

View a yearly report from the Landlords FSO system.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

[ID]  = Id of the request made.

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/viewYearlyReport/[key]/[type]/[ID]",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETviewFiveYearlyReport

https://landlordsfso.co.uk/api/properties/viewFiveYearlyReport/[key/[type]/[ID]

View a five yearly report from the Landlords FSO system.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

[ID]  = Id of the request made.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/viewFiveYearlyReport/[key/[type]/[ID]",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

GETviewFireRiskReport

https://landlordsfso.double-click.co.uk/api/properties/viewFireRiskReport/[key]/[type]/[ID]

View a fire risk report from the Landlords FSO system.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

[ID]  = Id of the request made.


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.double-click.co.uk/api/properties/viewFireRiskReport/[key]/[type]/[ID]",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTcreateProperty

https://landlordsfso.co.uk/api/properties/createProperty/[key]/[type]/

Create A Property Endpoint. * marks the required fields. You must submit all the form data displayed below, but only * marked fields are required data.

For county list please use the "listCounties" API method.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

Body Formdata

title*  String (255)
address_line_1*  String (255)
address_line_2  String (255)
city*  String (255)
county*  String (255)
postcode*  String (255)

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/createProperty/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"address_line_1\"\r\n\r\n70 Holbrook Road\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"county\"\r\n\r\nSouth Yorkshire\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"city\"\r\n\r\nsheffield\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"postcode\"\r\n\r\n S13 8AX\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTdeactivateProperty

https://landlordsfso.co.uk/api/properties/deactivateProperty/[key]/[type]/

To deactivate a property in the system (Delete)

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

property_id INT 

    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/deactivateProperty/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"property_id\"\r\n\r\n6\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTactivateProperty

https://landlordsfso.co.uk/api/properties/activateProperty/[key]/[type]/

To activate a property again.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

property_id INT

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/activateProperty/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"property_id\"\r\n\r\n5\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTdeleteMonthlyReport

https://landlordsfso.co.uk/api/properties/deleteMonthlyReport/[key]/[type]/

To Delete A Monthly Report.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

report_id The Report ID

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/deleteMonthlyReport/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"report_id\"\r\n\r\n5\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTdeleteSixMonthlyReport

https://landlordsfso.co.uk/api/properties/deleteSixMonthlyReport/[key]/[type]/

To Delete A Six Monthly Report.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

report_id The ID of the Report

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/deleteSixMonthlyReport/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"report_id\"\r\n\r\n2\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTdeleteYearlyReport

https://landlordsfso.double-click.co.uk/api/properties/deleteYearlyReport/[key]/[type]/

To Delete a Yearly Report

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

report_id The ID of the Report

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.double-click.co.uk/api/properties/deleteYearlyReport/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"report_id\"\r\n\r\n2\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTdeleteFiveYearlyReport

https://landlordsfso.co.uk/api/properties/deleteFiveYearlyReport/[key]/[type]/

To delete a Five Year Report

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

report_id The ID of the report

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/deleteFiveYearlyReport/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"report_id\"\r\n\r\n2\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTdeleteFireRiskReport

https://landlordsfso.co.uk/api/properties/deleteFireRiskReport/[key]/[type]/

To delete a Fire Risk Report

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

report_id The ID of the report

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/deleteFireRiskReport/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"report_id\"\r\n\r\n2\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTupdateProperty

https://landlordsfso.co.uk/api/properties/updateProperty/[key]/[type]/

To update the property details. All fields are needing to be sent, fields marked with a * must not be empty. Please perserve the order of the keys to ensure the data remains consistent.

For county list please use the "listCounties" API method.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

Body Formdata

title* STR
address_line_1* STR
address_line_2 STR
city* STR
county* STR
postcode* STR
property_id* INT
address_id* INT

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/updateProperty/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"address_line_1\"\r\n\r\n68 Holbrook Road\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"city\"\r\n\r\nSheffield\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"postcode\"\r\n\r\nS13 8AT\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"county\"\r\n\r\nSouth Yorkshire\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"property_id\"\r\n\r\n11\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTaddFireRiskCheck

https://landlordsfso.co.uk/api/properties/addFireRiskCheck/[key]/[type]/

Add a fire risk to Landlords FSO system.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

Body Formdata

file Your uploaded Document
property_id The property the report belongs too.
check_date The date the check was performed

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/addFireRiskCheck/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"property_id\"\r\n\r\n11\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"check_date\"\r\n\r\n12/07/2018\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTaddFiveYearlyCheck

https://landlordsfso.co.uk/api/properties/addFiveYearlyCheck/[key]/[type]/

Add a five year check to the Landlords FSO system.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

Body Formdata

file Your uploaded document
property_id The ID of the property we are assigning it to
check_date When the check was performed

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/addFiveYearlyCheck/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"property_id\"\r\n\r\n11\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"check_date\"\r\n\r\n12/07/2018\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTaddYearlyCheck

https://landlordsfso.co.uk/api/properties/addYearlyCheck/[key]/[type]/

Add yearly Check to the Landlords FSO system.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

Body Formdata

file Your uploaded Document
property_id The property the report belongs too.
check_date The date the check was performed 

    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/addYearlyCheck/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "------WebKitFormBoundary7MA4YWxkTrZu0gW\r\nContent-Disposition: form-data; name=\"file\"\r\n\r\n\r\n------WebKitFormBoundary7MA4YWxkTrZu0gW--",
  CURLOPT_HTTPHEADER => array(
    "content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTaddSixMonthlyCheck

https://landlordsfso.co.uk/api/properties/addSixMonthlyCheck/[key]/[type]/

Add a six monthly Check to the Landlords FSO system.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

Body Formdata

file Your uploaded Document
property_id The property the report belongs too.
check_date The date the check was performed 

    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/addSixMonthlyCheck/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
 

POSTaddMonthlyCheck

https://landlordsfso.co.uk/api/properties/addMonthlyCheck/[key]/[type]/

Add A Monthly Check To The Landlords FSO System.

[key] = customers API key located in the accounts section within the dashboard.

[type] = We supply 2 types of feeds, xml or json. Put the request paramater in the url for the required parsing return data.

Body Formdata

property_id (INT)
check_date yyyy-mm-dd
fire_equipment BOOL
fire_alarm BOOL
housekeeping BOOL
moe BOOL
emergency_lighting BOOL
aov BOOL
doors BOOL
callpoint_location TEXT
comments TEXT
remedial_action TEXT
completed_by varchar

 


    <?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://landlordsfso.co.uk/api/properties/addMonthlyCheck/[key]/[type]/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}