PostRentersInsurance4_0

This method is to be used to add or update renters insurance policy information for residents in ResMan.

Request

Data is added or updated by performing a HTTP Post to https://api.myresman.com/MITS/PostRentersInsurance4_0  supplying the listed parameters below.  

Parameters

The following demonstrates one way of submitting a request to the PostRentersInsurance4_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"] = “<RenterInsurance>...</RenterInsurance>”;

string url = "https://api.myresman.com/MITS/PostRentersInsurance4_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 Renters Insurance 4.0 standard  to create a new renter insurance 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 or update records.

Example XML - PostRentersInsurance4_0.xml

<RenterInsurance>

          <Requests>

                <Request>

                          <Identification IDValue="78508E2F-D0E2-4371-8A4C-EB7453283542" OrganizationName="ResMan" IDType="ParentLeaseGroupID" />

                          <TransactionDetails>

                                    <Product>Export</Product>

                                    <Action>New</Action>

                          </TransactionDetails>

                          <Insured>

                                    <Persons>

                                              <Individual>

                                                <Identification IDValue="E7C1EEDB-2D47-4399-B5E3-8159AD772E9A" OrganizationName="ResMan" IDType="PersonID" />

                                                <Name>

                                                          <FirstName>John</FirstName>

                                                          <MiddleName>Rodger</MiddleName>

                                                          <LastName>Resident</LastName>

                                                </Name>

                                                <Address />

                                                <DateOfBirth>1984-09-12</DateOfBirth>

                                              </Individual>

                                    </Persons>

                          </Insured>

                          <InsurancePolicy>

                            <Identification IDValue="C485D4CF-8CE8-419E-A2E6-2D4E21ED2C3A" OrganizationName="ResMan" IDType="RentersInsuranceID" />

                            <Insurer>

                                      <Name>Citywide Insurance</Name>

                            </Insurer>

                            <PolicyNumber>123456789</PolicyNumber>

                            <PolicyDetails>

                                      <EffectiveDate>2013-12-01</EffectiveDate>

                                      <ExpirationDate>2014-12-01</ExpirationDate>

                                      <CancelDate>2014-06-01</CancelDate>

                                      <Coverage>

                                        <Identification IDValue="CI" OrganizationName="Citywide Insurance" IDType="PolicyType" />

                                        <LiabilityAmount>50000</LiabilityAmount>

                                      </Coverage>

                                      <Notes>Contact Rhonda for questions about the policy</Notes>

                            </PolicyDetails>

                          </InsurancePolicy>

                </Request>

                <Request>...</Request>

                <Request>...</Request>

          </Requests>

</RenterInsurance>

Response

When submitting a request to the PostRentersInsurance4_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.

If posting the renters insurance records is successful, there will be an additional Identification node included in each of the request’s InsurancePolicy nodes that contains ResMan’s identifier for the policy. You can use this in the future to update the policy by including the exact same Identification node (with an OrganizationName of “ResMan” and an IDType of “RentersInsuranceID”) in the InsurancePolicy node.

<ResMan>

         <MethodName>PostRentersInsurance4_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 LeadManagement xml that is accepted and returned.

Request Node

In order to add a renters insurance policy correctly, the Request node will need to include three nodes; Identification, Insured, and Insurance Policy nodes.

Identification Node - This node contains the ResMan ParentLeaseGroupID that identifies which leases the policies should be added to.  This ID can be obtained using the SearchResidents API call (See ResMan Leasing API Docuementation)

Insured Node - This node will include a list of all the people included on the insurance policy

InsurancePolicy Node - This node will include the insurance policy information

<Request>

          <Identification IDValue="78508E2F-D0E2-4371-8A4C-EB7453283542" OrganizationName="ResMan" IDType="ParentLeaseGroupID" />

          <TransactionDetails>...</TransactionDetails>

          <Insured>...</Insured>

        <InsurancePolicy>...</InsurancePolicy>

</Request>

Insured Node

The Insured node must include the ResMan PersonID and name of each person that is specified on the insurance policy.  The ResMan PersonID can be obtained using the SearchResidents API call (See ResMan Leasing API Documentation).  Note that this does not follow the MITS Renters Insurance 4.0 standard but has been added to ensure data integrity.

<Insured>

        <Persons>

              <Individual>

                <Identification IDValue="E7C1EEDB-2D47-4399-B5E3-8159AD772E9A" OrganizationName="ResMan" IDType="PersonID" />

                <Name>

                          <FirstName>John</FirstName>

                          <MiddleName>Roger</MiddleName>

                          <LastName>Resident</LastName>

                </Name>

                <Address />

                <DateOfBirth>1984-09-12</DateOfBirth>

              </Individual>

              <Individual>

                <Identification IDValue="1CC674E3-DF0F-4A44-B10D-1771B4EA9B11" OrganizationName="ResMan" IDType="PersonID" />

                <Name>

                          <FirstName>Mary</FirstName>

                          <MiddleName>Elizabeth</MiddleName>

                          <LastName>Resident</LastName>

                </Name>

                <Address />

                <DateOfBirth>1986-02-25</DateOfBirth>

              </Individual>

    </Persons>

 </Insured>

InsurancePolicy Node

The InsurancePolicy node includes the insurance policy information including the policy number and  liability amount.  The Identification node included in the Coverage node will be used to identify what type of policy was purchased.  During the process of integration, a predefined set of policy types will be established between ResMan and the partner.  If the policy was purchased through the partner, one of the predefined policy types must be provided in the IDValue attribute of the Identification node.  If the Coverage node does not include an Identification node, the policy will be imported as third party policy not tied to any partner specific policy.

If an Identification node exists for the InsurancePolicy node, and it has an OrganizationName of “ResMan” and an IDType of “RentersInsuranceID”, the IDValue of the Identification will be used to find the renters insurance record, instead of using the value in the PolicyNumber node to find the record.

<InsurancePolicy>

         <Identification IDValue="C485D4CF-8CE8-419E-A2E6-2D4E21ED2C3A" OrganizationName="ResMan" IDType="RentersInsuranceID" />

    <Insurer>

              <Name>Citywide Insurance</Name>

    </Insurer>

    <PolicyNumber>123456789</PolicyNumber>

    <PolicyDetails>

              <EffectiveDate>2013-12-01</EffectiveDate>

              <ExpirationDate>2014-12-01</ExpirationDate>

              <CancelDate>2014-06-01</CancelDate>

              <Coverage>

                <Identification IDValue="CI" OrganizationName="Citywide Insurance" IDType="PolicyType" />

                <LiabilityAmount>50000</LiabilityAmount>

              </Coverage>

              <Notes>Contact Rhonda for questions about the policy</Notes>

    </PolicyDetails>

  </InsurancePolicy>

Adding a New Renters Insurance Record

A new renters insurance policy will be added to a lease when a request is received and the provided value in the PolicyNumber node does not match the policy number of an existing renters insurance record.

Updating an Existing Renter Insurance Record

A renters insurance policy will be updated when a request is received and the provided value in the PolicyNumber node does match the policy number of an existing renters insurance record.  If an Identification node exists for the InsurancePolicy node, and it has an OrganizationName of “ResMan” and an IDType of “RentersInsuranceID”, the IDValue of the Identification will be used to find the renters insurance record, instead of using the value in the PolicyNumber node to find the record.

Deleting a Renters Insurance Record

A renters insurance policy will be deleted when the Action node value in a TransactionDetails node is “Delete”.

<Request>

          ...

          <TransactionDetails>

                 <Action>Delete</Action>

         </TransactionDetails>

         ...

</Request>

Possible Errors

If any errors occur while parsing the XML sent to the API, they will be returned in the ErrorDescription node. The ErrorDescription node contains a list of error messages logged while parsing the XML.

The following errors will be logged and returned:

• "Missing PolicyNumber node" - An InsurancePolicy node is missing a PolicyNumber node
• "Person ID [id] not found on lease" - A PersonID from a Person Identification node could not be found on the lease matched to the LeaseID from a Request Identification node
• "Unable to parse the Individual Identification IDValue [value]" - An Individual Identification IDValue is not in a correct format
• "Missing Request Insured node" - A Request node is missing an Insured node
• "Missing Request InsurancePolicy node" - A Request node is missing an InsurancePolicy node
• "Missing InsurancePolicy PolicyDetails node" - An InsurancePolicy node is missing a PolicyDetails node
• "Missing PolicyDetails Coverage node" - A PolicyDetails node is missing a Coverage node
• "Missing Coverage LiabilityAmount node" - A Coverage node is missing a LiabilityAmount node
• "Policy Type [type] not found" - A Coverage Identification IDValue could not be matched to a predefined policy type
• "Missing Individual Identification node" - An Individual node is missing an Identification node
• "Lease could not be found" - A Request Identification IDValue could not matched to an existing lease
• "Unable to parse the Request Identification IDValue" - A Request Identification IDValue is not in a correct format
• "Missing Request Identification node" - A Request node is missing an Identification node
• "Invalid Request Identification node" - A Request node is missing an OrganizationName of ResMan and an IDType of ParentLeaseGroupID

Unused Nodes

There is some data supported in the MITS specification that is not currently supported by ResMan. The following elements or attributes will not be used if sent:

• Header
• Requests

• Request

• TransactionDetails

• OtherActionDescription

• Insured

• Persons

• Individual

• Name
• Address

• MarketingName
• UnitType
• UnitBedrooms
• UnitBathrooms
• MinSquareFeet
• MaxSquareFeet
• SquareFootType
• UnitRent
• MarketRent
• UnitEconomicStatus
• UnitEconomicStatusDescription
• UnitOccupancyStatus
• UnitLeasedStatus
• UnitLeasedStatusDescription
• NumberOccupants
• FloorplanName
• PhaseName
• BuildingName
• Address

• DateOfBirth

• Lease

• InsurancePolicy

• Insurer

• Address

• PremiumID
• PolicyTitle
• PolicyDetails

• ReinstateDate
• Term
• RiskZipCode
• RiskState
• IsRequiredForMoveIn
• IsPMInterestedParty
• PremiumCharge

• Billing
• Coverage

• Statuses

GetRentersInsurance4_0

This method will return the insurance policy information for the residents on the specified lease within ResMan.

Request

Data is added or updated by performing a HTTP Post to https://api.myresman.com/MITS/GetRentersInsurance4_0  supplying the listed parameters below.  

Parameters

Response

The response will be provided in xml.  The response will contain information about the method called, the parameters supplied as well as renters insurance data.  Below is an example of the response you can expect from this method.

If the request is successful, there will be an additional Identification node included in each of the request’s InsurancePolicy nodes that contains ResMan’s identifier for the policy. You can use this in the future to update the policy by including the exact same Identification node (with an OrganizationName of “ResMan” and an IDType of “RentersInsuranceID”) in the InsurancePolicy node.

XML Response

<ResMan>

          <MethodName>GetRentersInsurance4_0</MethodName>

          <Status>Success</Status>

          <AccountID>400</AccountID>

          <PropertyID>07413576-f764-44c6-be35-df4139deec01</PropertyID>

          <Response>[XML encoded response following the MITS Renters Insurance 4.0 Standard]</Response>

</ResMan>

Example Response Node

<RenterInsurance xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

         <Requests>

                 <Request>

                         <Identification IDValue="78508E2F-D0E2-4371-8A4C-EB7453283542" OrganizationName="ResMan" IDType="ParentLeaseGroupID" />

                          <TransactionDetails>

                                    <Product>Export</Product>

                                    <Action>Verify</Action>

                          </TransactionDetails>

                          <Insured>

                                    <Persons>

                                              <Individual>

                                                <Identification IDValue="E7C1EEDB-2D47-4399-B5E3-8159AD772E9A" OrganizationName="ResMan" IDType="PersonID" />

                                                <Name>

                                                          <FirstName>John</FirstName>

                                                          <MiddleName>Rodger</MiddleName>

                                                          <LastName>Resident</LastName>

                                                </Name>

                                                <Address />

                                                <DateOfBirth>1984-09-12</DateOfBirth>

                                              </Individual>

                                    </Persons>

                          </Insured>

                          <InsurancePolicy>

                            <Identification IDValue="C485D4CF-8CE8-419E-A2E6-2D4E21ED2C3A" OrganizationName="ResMan" IDType="RentersInsuranceID" />

                            <Insurer>

                                      <Name>Citywide Insurance</Name>

                            </Insurer>

                            <PolicyNumber>123456789</PolicyNumber>

                            <PolicyDetails>

                                      <EffectiveDate>2013-12-01</EffectiveDate>

                                      <ExpirationDate>2014-12-01</ExpirationDate>

                                      <CancelDate>2014-06-01</CancelDate>

                                      <Coverage>

                                        <Identification IDValue="CI" OrganizationName="Citywide Insurance" IDType="PolicyType" />

                                        <LiabilityAmount>50000</LiabilityAmount>

                                      </Coverage>

                                      <Notes>Contact Rhonda for questions about the policy</Notes>

                            </PolicyDetails>

                          </InsurancePolicy>

                 </Request>

         </Requests>

</RenterInsurance>