This method is to be used to add or update lease records, including the people on the lease record and any events that need to be recorded.
Request
Data is added or updated by performing a HTTP Post to https://api.myresman.com/MITS/PostLeaseApplication3_0 supplying the listed parameters below.
Parameters
Name | Description | Example | Required |
IntegrationPartnerID | The ID assigned to your company by ResMan | 1000 | Yes |
ApiKey | The API key assigned to your company by ResMan | a5w7d9g2m04… | Yes |
AccountID | The AccountID associated with the property | 400 | Yes |
PropertyID | The PropertyID associated with the property | 07413576-f764-44c6-be35-df4139deec01 | Yes |
Xml | The MITS Lease Application 3.0 compliant xml | See below | Yes |
The following demonstrates one way of submitting a request to the PostLeadManagment4_0 method using C#.
NameValueCollection postData = new NameValueCollection();
// Integration Partner values
postData["IntegrationPartnerID"] = "1000";
postData["ApiKey"] = "6aw7y9m3m04849lqld6em9sudl5fg01u";
// Account and property specific data
postData["AccountID"] = "400";
postData["PropertyID"] = "07413576-f764-44c6-be35-df4139deec01";
// Method specific parameters
postData["Xml"] = “<LeaseApplication>...</LeaseApplication>”;
string url = "https://api.myresman.com/MITS/PostLeaseApplication3_0";
WebClient client = new WebClient();
byte[] response = client.UploadValues(url, "POST", postData);
string strResponse = System.Text.Encoding.Default.GetString(response);
Posting Xml Parameter
Below is example XML following the MITS Lease Application 3.0 standard to create a new lease record. The remainder of this document will go through each section of the example below explaining how the data in each will be used and what data to include in order to make new and update requests.
Example XML - PostLeaseApplications3_0.xml
<LeaseApplication>
<Tenant>
<Identification IDType="PersonID">
<IDValue>38187384-B8C1-4EB6-9FE0-66B5EAD11276</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Identification IDType="ProspectID">
<IDValue>72604830-4B3F-4A74-81FD-F1715D5140E8</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Reference ReferenceType="EmergencyContact">
<ContactInfo>
<Identification>
<IDValue>Friend</IDValue>
</Identification>
<Name>
<FirstName>Harrison</FirstName>
<LastName>Jones</LastName>
</Name>
<Address AddressType="current">
<Address>456 Main St.</Address>
<City>San Jose</City>
<State>CA</State>
<PostalCode>95129</PostalCode>
<Country>USA</Country>
</Address>
<Phone PhoneType="other">
<PhoneNumber>(888) 888-8888</PhoneNumber>
</Phone>
</ContactInfo>
<Description>Friend</Description>
</Reference>
<Name>
<FirstName>Jeffrey</FirstName>
<LastName>Winger</LastName>
</Name>
<BirthDate>1973-09-28</BirthDate>
<Residence MoveInDate="2011-01-01" Rent="1000.00">
<Address AddressType="current">
<Address>123 Main Str.</Address>
<City>Mountain View</City>
<State>CA</State>
<PostalCode>94040</PostalCode>
<Country>USA</Country>
</Address>
</Residence>
<Phone PhoneType="cell">
<PhoneNumber>(777) 777-7777</PhoneNumber>
</Phone>
<Phone PhoneType="home">
<PhoneNumber>(777) 888-888</PhoneNumber>
</Phone>
<Phone PhoneType="office">
<PhoneNumber>(777) 999-999</PhoneNumber>
</Phone>
<Finances>
<Occupation Start="2009-09-03">
<Title>Worker</Title>
<Employer>
<Identification>
<IDValue/>
</Identification>
<CompanyName>Insuracare</CompanyName>
<Address AddressType="current">
<Address>456 Center Str.</Address>
<City>Lion City</City>
<State>OH</State>
<PostalCode>81347</PostalCode>
<Country>USA</Country>
</Address>
<Phone PhoneType="office">
<PhoneNumber>(444) 555-5555</PhoneNumber>
</Phone>
</Employer>
<Supervisor>
<Identification>
<IDValue/>
</Identification>
<Name>
<FirstName>Mike</FirstName>
<LastName>Sullivan</LastName>
</Name>
</Supervisor>
<Salary Frequency="Monthly">
<Amount>3524.67</Amount>
</Salary>
</Occupation>
</Finances>
</Tenant>
<Tenant>
<Identification IDType="PersonID">
<IDValue>E307DD59-10B4-49EE-9846-360D98E04FB7</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Identification IDType="ProspectID">
<IDValue>72604830-4B3F-4A74-81FD-F1715D5140E8</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Name>
<FirstName>Pierce</FirstName>
<LastName>Hawthorne</LastName>
</Name>
<BirthDate>1953-03-18</BirthDate>
<Residence MoveInDate="2011-01-01" Rent="1000.00">
<Address AddressType="current">
<Address>321 Center Str.</Address>
<City>Hill City</City>
<State>FL</State>
<PostalCode>32807</PostalCode>
<Country>USA</Country>
</Address>
</Residence>
<Phone PhoneType="cell">
<PhoneNumber>(888) 777-7777</PhoneNumber>
</Phone>
<Phone PhoneType="home">
<PhoneNumber>(888) 888-888</PhoneNumber>
</Phone>
<Phone PhoneType="office">
<PhoneNumber>(888) 999-999</PhoneNumber>
</Phone>
</Tenant>
<LA_Lease>
<Identification IDType="ProspectID">
<IDValue>72604830-4B3F-4A74-81FD-F1715D5140E8</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<AccountingData>
<ChargeSet Frequency="Monthly" Start="2013-12-10">
<Charge ChargeType="Base Rent">
<Identification IDType="TransactionCategoryID">
<IDValue>71604830-4B3F-4A74-81FD-F1715D5140E8</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Amount>850.00</Amount>
</Charge>
</ChargeSet>
<ChargeSet Frequency="One-Time" Start="2013-12-10">
<Charge ChargeType="Security Deposit">
<Identification IDType="TransactionCategoryID">
<IDValue>830ae543-4B3F-4A74-81FD-F1715D5140E8</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Amount>500.00</Amount>
</Charge>
<Charge ChargeType="Administrative Fee">
<Identification IDType="TransactionCategoryID">
<IDValue>02016c2b-fa26-498b-ad7c-e90d477c649a</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Amount>50.00</Amount>
</Charge>
<Charge ChargeType="Application Fee">
<Identification IDType="TransactionCategoryID">
<IDValue>69a3cf7f-f5f3-468e-8e1d-c37a2df2810</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Amount>25.00</Amount>
</Charge>
</ChargeSet>
</AccountingData>
<LeaseEvents>
<LeaseEvent Date="2013-12-31" EventType="LeaseFrom"></LeaseEvent>
<LeaseEvent Date="2014-12-31" EventType="LeaseTo"></LeaseEvent>
<LeaseEvent Date="2013-12-11" EventType="Application"></LeaseEvent>
</LeaseEvents>
<Unit>
<Identification IDType="UnitID">
<IDValue>305</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<MarketingName>305</MarketingName>
</Unit>
<ParkingStorage>
<Vehicle>
<Color>Silver</Color>
<LicenseNumber>C23422</LicenseNumber>
<LicenseState>MN</LicenseState>
<Make>Ford</Make>
<Model>Taurus</Model>
<PermitNumber>1234</PermitNumber>
</Vehicle>
</ParkingStorage>
<Pets>
<Pet Count="1" Description="Fluffy" PetType="Dog" Weight="20"/>
</Pets>
<Property>
<Identification IDType="PropertyID">
<IDValue>07413576-f764-44c6-be35-df4139deec01</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<MarketingName>202</MarketingName>
</Property>
<Status>
<ApprovalStatus>Pending</ApprovalStatus>
</Status>
</LA_Lease>
</LeaseApplication>
Response
When submitting a request to PostLeaseApplication3_0, you will receive a response following the pattern below. The response will include information about the method that was called as well as a status indicating whether or not the request was successful. If there was an error in the request, the ErrorDescription node will identify any problems with the request. In addition the submitted request XML will be included in the Response node and will be modified to include various Identification nodes containing the values that will need to be included when updating an existing record.
<ResMan>
<MethodName>PostLeaseApplication3_0</MethodName>
<Status>Success</Status>
<AccountID>400</AccountID>
<PropertyID>07413576-f764-44c6-be35-df4139deec01</PropertyID>
<ErrorDescription />
<Response>[Submitted request xml with added identification nodes]</Response>
</ResMan>
The next few sections of this document will explain each node of the Lease Application xml that is accepted and returned.
Tenant Node
This node contains information about a single tenant on a lease. Each tenant node will update a person record for the indicated prospect.
Updating an Existing Tenant
Providing a Tenant node with an Identification node with an IDType of “PersonID” and an OrganizationName of “ResMan” will update the person tied to that ID. Note that it is important to also include the LeaseID as returned in the initial posting if updating an existing application.
<Tenant>
<Identification IDType="PersonID">
<IDValue>F49993B2-40B1-40DE-94A2-608FB4376F81</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Identification IDType="ProspectID">
<IDValue>773C04F0-C10A-421A-8B70-B12F5EA6D98C</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Identification IDType="LeaseID">
<IDValue>8d27ee10-8111-4629-b9f4-3cae34b53253</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Name>
<FirstName>Harry</FirstName>
<LastName>Prospect</LastName>
</Name>
<BirthDate>1992-08-26</BirthDate>
</Tenant>
Tenant Node Response
In the response, each Tenant node will include at least two Identification nodes, one with an ID Type of “LeaseID” and one with an ID Type of “PersonID” (identifies an individual person). The OrganizationName attribute for both Identification nodes will have a value of “ResMan”. When updating an existing applicant, include the LeaseID identification node in the Tenant record.
<Tenant>
<Identification IDType="PersonID">
<IDValue>22C90F0F-187C-4364-9984-B02E88BC1C78</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
...
<Identification IDType="LeaseID">
<IDValue>8d27ee10-8111-4629-b9f4-3cae34b53253</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
...
</Tenant>
Tenant Node Possible Errors
If any errors occur while parsing the XML sent to the API, they will be returned in two ways; aggregated in the ErrorDescription node and in the Response node. The ErrorDescription node contains a list of error messages logged while parsing the XML. The Response node contains the original XML as well as Error nodes where errors were found.
The following errors will be logged and returned:
Below is an example response if a Tenant node is missing a Name node:
<ResMan>
<MethodName>PostLeaseApplication3_0</MethodName>
<Status>Error</Status>
<AccountID>400</AccountID>
<PropertyID>07413576-f764-44c6-be35-df4139deec01</PropertyID>
<ErrorDescription>
Missing Tenant Name node
</ErrorDescription>
<Response>
<LeaseApplication>
<Tenant>
<Identification IDType="PersonID">
<IDValue>F49993B2-40B1-40DE-94A2-608FB4376F81</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Identification IDType="LeaseID">
<IDValue>db430f5d-a6fc-4846-9802-05471b110857</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<BirthDate>1992-08-26</BirthDate>
<Error>Missing Tenant Name node</Error>
</Tenant>
...
</LeaseApplication>
</Response>
</ResMan>
LA_Lease Node
This node contains lease information. Each lease node will either create or update a lease record.
Creating a new Lease
Providing a Tenant node with an Identification node with an IDType of “ProspectID” and with an OrganizationName of “ResMan” will convert the prospect matching the Prospect ID to a Resident. Providing a LA_Lease node with an IDType of “ProspectID” and an OrganizationName of “ResMan” that matches the Tenant node’s Identification of IDType “ProspectID” will create a new Lease record. Both nodes (Tenant and LA_Lease) are required to convert a Prospect to a Resident and create a Lease for the Resident.
<LA_Lease>
<Identification IDType="ProspectID">
<IDValue>773C04F0-C10A-421A-8B70-B12F5EA6D98C</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<AccountingData>
<ChargeSet Frequency="Monthly" Start="2013-12-10">
<Charge ChargeType="Base Rent">
<Identification IDType="TransactionCategoryID">
<IDValue>71604830-4B3F-4A74-81FD-F1715D5140E8</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Amount>850.00</Amount>
</Charge>
</ChargeSet>
<ChargeSet Frequency="One-Time" Start="2013-12-10">
<Charge ChargeType="Security Deposit">
<Identification IDType="TransactionCategoryID">
<IDValue>830ae543-4B3F-4A74-81FD-F1715D5140E8</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Amount>500.00</Amount>
</Charge>
</ChargeSet>
</AccountingData>
<LeaseEvents>
<LeaseEvent Date="2013-09-27" EventType="LeaseFrom"></LeaseEvent>
<LeaseEvent Date="2014-09-27" EventType="LeaseTo"></LeaseEvent>
<LeaseEvent Date="2013-09-26" EventType="Application"></LeaseEvent>
</LeaseEvents>
<ParkingStorage>
<Vehicle>
<Color>Black</Color>
<LicenseNumber>C23422</LicenseNumber>
<LicenseState>NC</LicenseState>
<Make>Ford</Make>
<Model>F150</Model>
<PermitNumber>1234</PermitNumber>
</Vehicle>
</ParkingStorage>
<Pets>
<Pet Count="1" Description="Budd" PetType="Dog" Weight="30"/>
</Pets>
<Property>
<Identification IDType="PropertyID">
<IDValue>07413576-f764-44c6-be35-df4139deec01</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<MarketingName>202</MarketingName>
</Property>
<Status>
<ApprovalStatus>Pending</ApprovalStatus>
</Status>
</LA_Lease>
Lease Statuses
Below is a list of lease statuses that are accepted along with a description for each status. Note that if a lease in ResMan is currently pending, a lease status of Approved must be sent before Signed, meaning that a lease cannot be changed from pending to signed in one step. It must first be set to approved, and then signed. If a lease has been cancelled or denied, its status cannot be changed.
MITS Lease Status | Action Performed |
Pending | The application will be submitted in a pending state |
Approved | The application will be approved |
Cancelled | The application and all applicants will be cancelled |
Denied | The application will be denied |
Signed | The application will be signed |
Update an Existing Lease
Providing a LA_Lease node with an Identification node with an IDType of “LeaseID” and an OrganizationName of “ResMan” will update the lease tied to that ID.
<LA_Lease>
<Identification IDType="LeaseID">
<IDValue>8d27ee10-8111-4629-b9f4-3cae34b53253</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
...
<LeaseEvents>
<LeaseEvent Date="2013-09-27" EventType="LeaseFrom"></LeaseEvent>
<LeaseEvent Date="2014-09-27" EventType="LeaseTo"></LeaseEvent>
<LeaseEvent Date="2013-09-26" EventType="Application"></LeaseEvent>
</LeaseEvents>
...
<Property>
<Identification IDType="PropertyID">
<IDValue>07413576-f764-44c6-be35-df4139deec01</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<MarketingName>202</MarketingName>
</Property>
...
</LA_Lease>
Lease Node Response
In the response, each Lease node will include an Identification node with an ID Type of “LeaseID”. The OrganizationName attribute for the Identification node will have a value of “ResMan”.
<LA_Lease>
...
<Identification IDType="LeaseID">
<IDValue>8d27ee10-8111-4629-b9f4-3cae34b53253</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
...
</LA_Lease>
Lease Node Possible Errors
If any errors occur while parsing the XML sent to the API, they will be returned in two ways; aggregated in the ErrorDescription node and in the Response node. The ErrorDescription node contains a list of error messages logged while parsing the XML. The Response node contains the original XML as well as Error nodes where errors were found.
The following errors will be logged and returned:
Below is an example response if a Lease Unit node is missing a MarketingName node:
<ResMan>
<MethodName>PostLeaseApplication3_0</MethodName>
<Status>Error</Status>
<AccountID>400</AccountID>
<PropertyID>07413576-f764-44c6-be35-df4139deec01</PropertyID>
<ErrorDescription>
Missing Unit MarketingName node
</ErrorDescription>
<Response>
<LeaseApplication>
...
<LA_Lease>
<Identification IDType="ProspectID">
<IDValue>773C04F0-C10A-421A-8B70-B12F5EA6D98C</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<LeaseEvents>
<LeaseEvent Date="2013-09-27" EventType="LeaseFrom"></LeaseEvent>
<LeaseEvent Date="2014-09-27" EventType="LeaseTo"></LeaseEvent>
<LeaseEvent Date="2013-09-26" EventType="Application"></LeaseEvent>
</LeaseEvents>
<Unit>
<Identification IDType="UnitID">
<IDValue>305</IDValue>
<OrganizationName>ResMan</OrganizationName>
</Identification>
<Error>Missing Unit MarketingName node</Error>
</Unit>
</LA_Lease>
</LeaseApplication>
</Response>
</ResMan>