Entrata Website Search

API

Code Snippet

Select any of the web services below to view details and examples.

API » Property Units » getUnitsAvailabilityAndPricing

getUnitsAvailabilityAndPricing

Pulls a list of Unit availability and their pricing



*propertyId [Integer] This is a required field. This field accepts single value. Property Id
floorplanId [Integer] This is an optional field. This field accepts single value. Floorplan Id
unitTypeId [Integer] This is an optional field. This field accepts single value. Unit Type Id
propertyUnitId [Integer] This is an optional field. This field accepts single value. Property Unit Id
availableUnitsOnly [Boolean] This is an optional field. This field accepts single value. If provided as 1 response will contain only available units. And If pr ovided as 0 response will contain all available and unavailable units
unavailableUnitsOnly [Boolean] This is an optional field. This field accepts single value. If provided value as 1 then will return only unavailable units in the response.
skipPricing [Boolean] This is an optional field. This field accepts single value. If provided value as 1 then will not show the rates(default API will r eturn the pricing)
showChildProperties [Boolean] This is an optional field. This field accepts single value. Shows child properties in result, by default child properties will be included in result.
includeDisabledFloorplans [Boolean] This is an optional field. This field accepts single value. Flag for implementing Disabled Floorplans on result.
includeDisabledUnits [Boolean] This is an optional field. This field accepts single value. Flag for implementing Disabled Units on result.
showUnitSpaces [Boolean] This is an optional field. This field accepts single value. showUnitSpaces
useSpaceConfiguration [Boolean] This is an optional field. This field accepts single value. Considered if the property has space configuration setup then the rate should return as per space configuration.
allowLeaseExpirationOverride [Boolean] This is an optional field. This field accepts single value. If '1' is sent then we should override any lease expiration limits aff ecting available units returned/ If '0' or node is missing then do cur rent default functionality
moveInStartDate [Date] This is an optional field. This field accepts single value. Desired move in start date for finding unit availability and pricing.
moveInEndDate [Date] This is an optional field. This field accepts single value. Desired move in end date for finding unit availability and pricing.
No Parameters Found.

Request URL

https://YOUR_DOMAIN.docs.entrata.com/api/propertyunits

Request Type

Request Copy to Clipboard

Response Copy to Clipboard



/* An Example XML Request */
string xmlRequest = '';

/* An Example JSON Request */ string jsonRequest = '';
/* Initiate a Web Request object */ HttpWebRequest webRequest = null; webRequest = WebRequest.Create(' REPLACE THIS WITH THE WEB SERVICE URL ') as HttpWebRequest; webRequest.Method = 'POST'; webRequest.Headers.Add("Authorization", "Basic ");
/* Add Form data */
FileInfo fi = new FileInfo(@"E:\RabitMQ\Learn RabbitMQ With C.pdf"); string fileName = fi.Name; byte[] fileContents = File.ReadAllBytes(fi.FullName);
string boundary = "--AaB03x";
StringBuilder sb = new StringBuilder();
sb.AppendLine(boundary); sb.AppendLine(string.Format("Content-Disposition: form-data; name=\"{0}\"", "requestBody")); sb.AppendLine(); sb.AppendLine(xmlRequest);
sb.AppendLine(boundary); sb.AppendLine(string.Format("Content-Disposition: form-data; name=\"{0}\"", "requestContentType")); sb.AppendLine(); sb.AppendLine("application/xml; CHARSET=UTF-8");
sb.AppendLine(boundary); sb.AppendLine(string.Format("Content-Disposition: file; name=\"{0}\"; filename=\"{1}\"", "file1", fileName)); sb.AppendLine("Content-Type: application/octet-stream"); sb.AppendLine(); sb.AppendLine(Encoding.UTF8.GetString(fileContents)); sb.AppendLine(boundary);
/* Initiate the request writer */ StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream());
/* If you want to send an XML Request, use these options */ webRequest.ContentType = "multipart/form-data; boundary=AaB03x"; requestWriter.Write(xmlRequest);
/* If you want to send an XML Request, use these options */ webRequest.ContentType = 'multipart/form-data; boundary=AaB03x'; requestWriter.Write(jsonRequest);
requestWriter.Close();
/* Read the response */ StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream()); string responseData = responseReader.ReadToEnd(); responseReader.Close();

/* An Example XML Request */
string xmlRequest = '';

/* An Example JSON Request */ string jsonRequest = '';
import java.io.InputStream; import org.apache.commons.httpclient.HttpClient;
public class PostExample {
public static void main(String[] args){
HttpClient httpClient = new DefaultHttpClient();
try { HttpPost request = new HttpPost("REPLACE THIS WITH THE WEB SERVICE URL"); request.addHeader("Authorization", "Basic <BASE64 ENCODED VALUE OF USERNAME:PASSWORD>"); request.addHeader("content-type", "multipart/form-data");
File file1 = new File("[/path/to/upload]");
MultipartEntityBuilder builder = MultipartEntityBuilder.create(); builder.addBinaryBody( "file1", new FileInputStream( file1 ), ContentType.APPLICATION_OCTET_STREAM, file1.getName() );
/* If you want to send an XML Request, use these options */ builder.addTextBody( "requestBody", xmlRequest ); builder.addTextBody( "requestContentType", "APPLICATION/XML; CHARSET=UTF-8" );
/* If you want to send an JSON Request, use these options */ builder.addTextBody( "requestBody", jsonRequest ); builder.addTextBody( "requestContentType", "APPLICATION/JSON; CHARSET=UTF-8" );
HttpEntity multipartFormData = builder.build(); request.setEntity( multipartFormData );
HttpResponse response = httpClient.execute(request);
// handle response here... System.out.println(response); }catch (Exception ex) { // handle exception here ex.printStackTrace(); } finally { httpClient.getConnectionManager().shutdown(); } } }

/* An Example XML Request */
string xmlRequest = '' ;

/* An Example JSON Request */ $jsonRequest = '' ;
$resCurl = curl_init();
curl_setopt( $resCurl, CURLOPT_POST, true ); curl_setopt( $resCurl, CURLOPT_URL, REPLACE THIS WITH THE WEB SERVICE URL ); curl_setopt( $resCurl, CURLOPT_RETURNTRANSFER, 1 );
$strFirstFileName = '<filename with path>'; $strSecondFileName = '<filename with path>'; if( true == function_exists( 'curl_file_create' ) ) { $strFirsFilePath = curl_file_create( $strFirstFileName ); $strSecondFilePath = curl_file_create( $strSecondFileName ); } else { $strFirsFilePath = '@' . realpath( $strFirstFileName ); $strSecondFilePath = '@' . realpath( $strSecondFileName ); }
/* If you want to send an XML Request, use these options */ $arrmixPost = [ 'requestContentType' => 'APPLICATION/XML; CHARSET=UTF-8', 'requestBody' => $xmlRequest, 'file1' => $strFirsFilePath, 'file2' => $strSecondFilePath ]; /* If you want to send a JSON Request, use these options */ $arrmixPost = [ 'requestContentType' => 'APPLICATION/JSON; CHARSET=UTF-8', 'requestBody' => $jsonRequest, 'file1' => $strFirsFilePath, 'file2' => $strSecondFilePath ];
curl_setopt( $resCurl, CURLOPT_HTTPHEADER, array( 'Content-type: multipart/form-data', 'Authorization: Basic <BASE64 ENCODED VALUE OF USERNAME:PASSWORD>' ) ); curl_setopt( $resCurl, CURLOPT_POSTFIELDS, $arrmixPost ); $result = curl_exec( $resCurl ); if( false === $result ) { echo 'Curl error: ' . curl_error( $resCurl ); curl_close( $resCurl ); } else { curl_close( $resCurl ); echo $result; }
Domain .docs.entrata.com/api/v1/propertyunits
Request Parameter:
Username *
Password *
propertyId [Integer] *
floorplanId [Integer] optional
unitTypeId [Integer] optional
propertyUnitId [Integer] optional
availableUnitsOnly [Boolean]
Off
unavailableUnitsOnly [Boolean]
Off
skipPricing [Boolean]
Off
showChildProperties [Boolean]
Off
includeDisabledFloorplans [Boolean]
Off
includeDisabledUnits [Boolean]
Off
showUnitSpaces [Boolean]
Off
useSpaceConfiguration [Boolean]
Off
allowLeaseExpirationOverride [Boolean]
Off
moveInStartDate [Date] optional
moveInEndDate [Date] optional

Request Type

Request URL

Request Headers

Request Headers will be shown here

Request Copy to Clipboard

Request code will be shown here

Response Copy to Clipboard

Response code will be shown here

Response Headers

Response Headers will be shown here

Your life is about to
get a whole lot easier

Sign in
to Entrata