Entrata Website Search

API

Code Snippet

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

API » Maintenance » getWorkOrders

getWorkOrders

Retrieves work orders information.



*propertyId [Integer] This is a required field. This field accepts single value. Property Id
workOrderId [Integer] This is an optional field. This field accepts single value.
propertyUnitId [Integer] This is an optional field. This field accepts single value. propertyUnitId
vendorId [Integer] This is an optional field. This field accepts single value. vendorId
leaseStatusTypeIds [Integer] This is an optional field. This field accepts single value. leaseStatusTypeIds
workOrderTypeIds [Integer] This is an optional field. This field accepts single value. workOrderTypeIds
buildingName [String] This is an optional field. This field accepts single value. buildingName
unitNumber [String] This is an optional field. This field accepts single value. Unit number
maintenancePriorityId [Integer] This is an optional field. This field accepts single value. maintenancePriorityId
maintenanceCategoryId [Integer] This is an optional field. This field accepts single value. maintenanceCategoryId
maintenanceProblemId [Integer] This is an optional field. This field accepts single value. maintenanceProblemId
includeChildWorkOrders [Boolean] This is an optional field. This field accepts single value. includeChildWorkOrders
includeDeletedWorkOrders [Boolean] This is an optional field. This field accepts single value. If this flag is set to Yes then we are returning deleted work orders i n the response else we are not.
createdOnFromDate [Date] This is an optional field. This field accepts single value. createdOnFromDate
createdOnToDate [Date] This is an optional field. This field accepts single value. createdOnToDate
lastUpdatedOnFromDate [Date] This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter.
lastUpdatedOnToDate [Date] This is an optional field. This field accepts single value. If Location, Category, Problem, Description, Priority, and Status are updated then only work order will be returned in this filter.
completedOnFromDate [Date] This is an optional field. This field accepts single value. completedOnFromDate
completedOnToDate [Date] This is an optional field. This field accepts single value. completedOnToDate
No Parameters Found.

Request URL

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

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/maintenance
Request Parameter:
Username *
Password *
propertyId [Integer] *
workOrderId [Integer] optional
propertyUnitId [Integer] optional
vendorId [Integer] optional
leaseStatusTypeIds [Integer] optional
workOrderTypeIds [Integer] optional
buildingName [String] optional
unitNumber [String] optional
maintenancePriorityId [Integer] optional
maintenanceCategoryId [Integer] optional
maintenanceProblemId [Integer] optional
includeChildWorkOrders [Boolean]
Off
includeDeletedWorkOrders [Boolean]
Off
createdOnFromDate [Date] optional
createdOnToDate [Date] optional
lastUpdatedOnFromDate [Date] optional
lastUpdatedOnToDate [Date] optional
completedOnFromDate [Date] optional
completedOnToDate [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