POST api/Tenant

Manage tenant application

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
unitKey	integer	None.
applicationNumber	string	None.
propertyNumber	string	None.
buildingName	string	None.
streetNumber	string	None.
streetName	string	None.
apartment	string	None.
city	string	None.
state	string	None.
zipCode	string	None.
startDate	string	None.
contractTerm	string	None.
endDate	string	None.
contractAmount	string	None.
applicationCompletionDate	date	None.
type	string	None.
applicants	Collection of Applicant	None.
underageOccupants	Collection of UnderageOccupant	None.
pets	Collection of Pet	None.
vehicles	Collection of Vehicle	None.
emergencyContact	EmergencyContact	None.
reportUrl	string	None.

Request Formats

application/json, text/json

Sample:

{
  "unitKey": 1,
  "applicationNumber": "sample string 2",
  "propertyNumber": "sample string 3",
  "buildingName": "sample string 4",
  "streetNumber": "sample string 5",
  "streetName": "sample string 6",
  "apartment": "sample string 7",
  "city": "sample string 8",
  "state": "sample string 9",
  "zipCode": "sample string 10",
  "startDate": "sample string 11",
  "contractTerm": "sample string 12",
  "endDate": "sample string 13",
  "contractAmount": "sample string 14",
  "applicationCompletionDate": "2026-11-03T12:54:24.583622-06:00",
  "type": "sample string 15",
  "applicants": [
    {
      "applicantNumber": "sample string 1",
      "firstName": "sample string 2",
      "middleName": "sample string 3",
      "lastName": "sample string 4",
      "dob": "sample string 5",
      "phone": "sample string 6",
      "email": "sample string 7",
      "militaryStatus": "sample string 8",
      "employments": [
        {
          "employmentType2Label": "sample string 1",
          "employerName": "sample string 2",
          "jobTitle": "sample string 3",
          "address": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "zipcode": "sample string 7",
          "country": "sample string 8",
          "fromDate": "sample string 9",
          "salaryAmount": 1.0,
          "salaryPeriodLabel": "sample string 10",
          "contactName": "sample string 11",
          "contactTitle": "sample string 12",
          "contactPhone": "sample string 13",
          "contactEmail": "sample string 14"
        },
        {
          "employmentType2Label": "sample string 1",
          "employerName": "sample string 2",
          "jobTitle": "sample string 3",
          "address": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "zipcode": "sample string 7",
          "country": "sample string 8",
          "fromDate": "sample string 9",
          "salaryAmount": 1.0,
          "salaryPeriodLabel": "sample string 10",
          "contactName": "sample string 11",
          "contactTitle": "sample string 12",
          "contactPhone": "sample string 13",
          "contactEmail": "sample string 14"
        }
      ],
      "headShot": "sample string 9"
    },
    {
      "applicantNumber": "sample string 1",
      "firstName": "sample string 2",
      "middleName": "sample string 3",
      "lastName": "sample string 4",
      "dob": "sample string 5",
      "phone": "sample string 6",
      "email": "sample string 7",
      "militaryStatus": "sample string 8",
      "employments": [
        {
          "employmentType2Label": "sample string 1",
          "employerName": "sample string 2",
          "jobTitle": "sample string 3",
          "address": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "zipcode": "sample string 7",
          "country": "sample string 8",
          "fromDate": "sample string 9",
          "salaryAmount": 1.0,
          "salaryPeriodLabel": "sample string 10",
          "contactName": "sample string 11",
          "contactTitle": "sample string 12",
          "contactPhone": "sample string 13",
          "contactEmail": "sample string 14"
        },
        {
          "employmentType2Label": "sample string 1",
          "employerName": "sample string 2",
          "jobTitle": "sample string 3",
          "address": "sample string 4",
          "city": "sample string 5",
          "state": "sample string 6",
          "zipcode": "sample string 7",
          "country": "sample string 8",
          "fromDate": "sample string 9",
          "salaryAmount": 1.0,
          "salaryPeriodLabel": "sample string 10",
          "contactName": "sample string 11",
          "contactTitle": "sample string 12",
          "contactPhone": "sample string 13",
          "contactEmail": "sample string 14"
        }
      ],
      "headShot": "sample string 9"
    }
  ],
  "underageOccupants": [
    {
      "residentNumber": "sample string 1",
      "name": "sample string 2",
      "age": "sample string 3",
      "relationship": "sample string 4"
    },
    {
      "residentNumber": "sample string 1",
      "name": "sample string 2",
      "age": "sample string 3",
      "relationship": "sample string 4"
    }
  ],
  "pets": [
    {
      "petNumber": "sample string 1",
      "name": "sample string 2",
      "age": "sample string 3",
      "sex": "sample string 4",
      "weight": "sample string 5",
      "type": "sample string 6",
      "breed": "sample string 7",
      "description": "sample string 8",
      "license": "sample string 9"
    },
    {
      "petNumber": "sample string 1",
      "name": "sample string 2",
      "age": "sample string 3",
      "sex": "sample string 4",
      "weight": "sample string 5",
      "type": "sample string 6",
      "breed": "sample string 7",
      "description": "sample string 8",
      "license": "sample string 9"
    }
  ],
  "vehicles": [
    {
      "vehicleId": "sample string 1",
      "tagNumber": "sample string 2",
      "state": "sample string 3",
      "year": "sample string 4",
      "make": "sample string 5",
      "model": "sample string 6",
      "color": "sample string 7",
      "insuranceCompany": "sample string 8"
    },
    {
      "vehicleId": "sample string 1",
      "tagNumber": "sample string 2",
      "state": "sample string 3",
      "year": "sample string 4",
      "make": "sample string 5",
      "model": "sample string 6",
      "color": "sample string 7",
      "insuranceCompany": "sample string 8"
    }
  ],
  "emergencyContact": {
    "contactId": 1,
    "contactName": "sample string 2",
    "relationship": "sample string 3",
    "cellPhone": "sample string 4",
    "email": "sample string 5"
  },
  "reportUrl": "sample string 16"
}

application/xml, text/xml

Sample:

<TenantPackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VMSRXChange.DataClassesTenant">
  <apartment>sample string 7</apartment>
  <applicants>
    <Applicant>
      <applicantNumber>sample string 1</applicantNumber>
      <dob>sample string 5</dob>
      <email>sample string 7</email>
      <employments>
        <Employment>
          <address>sample string 4</address>
          <city>sample string 5</city>
          <contactEmail>sample string 14</contactEmail>
          <contactName>sample string 11</contactName>
          <contactPhone>sample string 13</contactPhone>
          <contactTitle>sample string 12</contactTitle>
          <country>sample string 8</country>
          <employerName>sample string 2</employerName>
          <employmentType2Label>sample string 1</employmentType2Label>
          <fromDate>sample string 9</fromDate>
          <jobTitle>sample string 3</jobTitle>
          <salaryAmount>1</salaryAmount>
          <salaryPeriodLabel>sample string 10</salaryPeriodLabel>
          <state>sample string 6</state>
          <zipcode>sample string 7</zipcode>
        </Employment>
        <Employment>
          <address>sample string 4</address>
          <city>sample string 5</city>
          <contactEmail>sample string 14</contactEmail>
          <contactName>sample string 11</contactName>
          <contactPhone>sample string 13</contactPhone>
          <contactTitle>sample string 12</contactTitle>
          <country>sample string 8</country>
          <employerName>sample string 2</employerName>
          <employmentType2Label>sample string 1</employmentType2Label>
          <fromDate>sample string 9</fromDate>
          <jobTitle>sample string 3</jobTitle>
          <salaryAmount>1</salaryAmount>
          <salaryPeriodLabel>sample string 10</salaryPeriodLabel>
          <state>sample string 6</state>
          <zipcode>sample string 7</zipcode>
        </Employment>
      </employments>
      <firstName>sample string 2</firstName>
      <headShot>sample string 9</headShot>
      <lastName>sample string 4</lastName>
      <middleName>sample string 3</middleName>
      <militaryStatus>sample string 8</militaryStatus>
      <phone>sample string 6</phone>
    </Applicant>
    <Applicant>
      <applicantNumber>sample string 1</applicantNumber>
      <dob>sample string 5</dob>
      <email>sample string 7</email>
      <employments>
        <Employment>
          <address>sample string 4</address>
          <city>sample string 5</city>
          <contactEmail>sample string 14</contactEmail>
          <contactName>sample string 11</contactName>
          <contactPhone>sample string 13</contactPhone>
          <contactTitle>sample string 12</contactTitle>
          <country>sample string 8</country>
          <employerName>sample string 2</employerName>
          <employmentType2Label>sample string 1</employmentType2Label>
          <fromDate>sample string 9</fromDate>
          <jobTitle>sample string 3</jobTitle>
          <salaryAmount>1</salaryAmount>
          <salaryPeriodLabel>sample string 10</salaryPeriodLabel>
          <state>sample string 6</state>
          <zipcode>sample string 7</zipcode>
        </Employment>
        <Employment>
          <address>sample string 4</address>
          <city>sample string 5</city>
          <contactEmail>sample string 14</contactEmail>
          <contactName>sample string 11</contactName>
          <contactPhone>sample string 13</contactPhone>
          <contactTitle>sample string 12</contactTitle>
          <country>sample string 8</country>
          <employerName>sample string 2</employerName>
          <employmentType2Label>sample string 1</employmentType2Label>
          <fromDate>sample string 9</fromDate>
          <jobTitle>sample string 3</jobTitle>
          <salaryAmount>1</salaryAmount>
          <salaryPeriodLabel>sample string 10</salaryPeriodLabel>
          <state>sample string 6</state>
          <zipcode>sample string 7</zipcode>
        </Employment>
      </employments>
      <firstName>sample string 2</firstName>
      <headShot>sample string 9</headShot>
      <lastName>sample string 4</lastName>
      <middleName>sample string 3</middleName>
      <militaryStatus>sample string 8</militaryStatus>
      <phone>sample string 6</phone>
    </Applicant>
  </applicants>
  <applicationCompletionDate>2026-11-03T12:54:24.583622-06:00</applicationCompletionDate>
  <applicationNumber>sample string 2</applicationNumber>
  <buildingName>sample string 4</buildingName>
  <city>sample string 8</city>
  <contractAmount>sample string 14</contractAmount>
  <contractTerm>sample string 12</contractTerm>
  <emergencyContact>
    <cellPhone>sample string 4</cellPhone>
    <contactId>1</contactId>
    <contactName>sample string 2</contactName>
    <email>sample string 5</email>
    <relationship>sample string 3</relationship>
  </emergencyContact>
  <endDate>sample string 13</endDate>
  <pets>
    <Pet>
      <age>sample string 3</age>
      <breed>sample string 7</breed>
      <description>sample string 8</description>
      <license>sample string 9</license>
      <name>sample string 2</name>
      <petNumber>sample string 1</petNumber>
      <sex>sample string 4</sex>
      <type>sample string 6</type>
      <weight>sample string 5</weight>
    </Pet>
    <Pet>
      <age>sample string 3</age>
      <breed>sample string 7</breed>
      <description>sample string 8</description>
      <license>sample string 9</license>
      <name>sample string 2</name>
      <petNumber>sample string 1</petNumber>
      <sex>sample string 4</sex>
      <type>sample string 6</type>
      <weight>sample string 5</weight>
    </Pet>
  </pets>
  <propertyNumber>sample string 3</propertyNumber>
  <reportUrl>sample string 16</reportUrl>
  <startDate>sample string 11</startDate>
  <state>sample string 9</state>
  <streetName>sample string 6</streetName>
  <streetNumber>sample string 5</streetNumber>
  <type>sample string 15</type>
  <underageOccupants>
    <UnderageOccupant>
      <age>sample string 3</age>
      <name>sample string 2</name>
      <relationship>sample string 4</relationship>
      <residentNumber>sample string 1</residentNumber>
    </UnderageOccupant>
    <UnderageOccupant>
      <age>sample string 3</age>
      <name>sample string 2</name>
      <relationship>sample string 4</relationship>
      <residentNumber>sample string 1</residentNumber>
    </UnderageOccupant>
  </underageOccupants>
  <unitKey>1</unitKey>
  <vehicles>
    <Vehicle>
      <color>sample string 7</color>
      <insuranceCompany>sample string 8</insuranceCompany>
      <make>sample string 5</make>
      <model>sample string 6</model>
      <state>sample string 3</state>
      <tagNumber>sample string 2</tagNumber>
      <vehicleId>sample string 1</vehicleId>
      <year>sample string 4</year>
    </Vehicle>
    <Vehicle>
      <color>sample string 7</color>
      <insuranceCompany>sample string 8</insuranceCompany>
      <make>sample string 5</make>
      <model>sample string 6</model>
      <state>sample string 3</state>
      <tagNumber>sample string 2</tagNumber>
      <vehicleId>sample string 1</vehicleId>
      <year>sample string 4</year>
    </Vehicle>
  </vehicles>
  <zipCode>sample string 10</zipCode>
</TenantPackage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.