Entrata Website Search

API

Code Snippet

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

API » Applications » sendApplicationEmployers

sendApplicationEmployers



*applicationId [Integer] This is a required field. This field accepts single value. Required parameter, accepts integer value.
*propertyId [Integer] This is a required field. This field accepts single value. Required parameter, accepts integer value.
id [Integer] This is an optional field. This field accepts single value. Conditionally Required parameter. If provided, it will update the empl oyer record on provided application. otherwise insert the employer rec ord.
incomeTypeId [Integer] This is an optional field. This field accepts single value. Conditionally Required parameter. If "id" is not provided, this parame ter is required.
customerId [Integer] This is an optional field. This field accepts single value. Conditionally Required parameter. If "id" is not provided, this parame ter is required.
frequencyId [Integer] This is an optional field. This field accepts single value. Optional parameter, accepts integer value. If provided should be a val id frequency range.
position [String] This is an optional field. This field accepts single value. Optional parameter, accepts string value
institutionName [String] This is an optional field. This field accepts single value. Optional parameter, accepts string value
institutionPhoneNumber [String] This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number.
institutionStreetLine1 [String] This is an optional field. This field accepts single value. Optional parameter, accepts string value
institutionStreetLine2 [String] This is an optional field. This field accepts single value. Optional parameter, accepts string value.
institutionStreetLine3 [String] This is an optional field. This field accepts single value. Optional parameter, accepts string value.
institutionCity [String] This is an optional field. This field accepts single value. Optional parameter, accepts string value.
institutionStateCode [String] This is an optional field. This field accepts single value. Optional parameter, accepts string value.
institutionProvince [String] This is an optional field. This field accepts single value. Optional parameter, accepts string value
institutionPostalCode [String] This is an optional field. This field accepts single value. Optional parameter, accepts string value.
institutionCountryCode [String] This is an optional field. This field accepts single value. Optional parameter, accepts string value
amount [Float] This is an optional field. This field accepts single value. Conditionally Required parameter, accepts float value with two decimal points. If Id is not provided, this becomes required.
contactName [String] This is an optional field. This field accepts single value. Optional parameter, accepts string value
contactPhone [String] This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid phone number.
contactEmail [String] This is an optional field. This field accepts single value. Optional parameter, accept string value. If provided, should be valid email format.
incomeEffectiveDate [Date] This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format .
dateStarted [Date] This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format.
dateEnded [Date] This is an optional field. This field accepts single value. Optional parameter, accept date in MM/DD/YYYY or YYYY-MM-DD format. if provided, then dateStarted and dateEnded should be in valid range. da teStarted should be less than dateEnded.
isDelete [Boolean] This is an optional field. This field accepts single value. Optional parameter, accept either 1 or 0. if provided value as 1 then id is required and the employer record will be removed from applicatio n.
No Parameters Found.

Request URL

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

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; }

Your life is about to
get a whole lot easier

Sign in
to Entrata