GET api/Prospect/GetProspect/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

ProspectModel

Name	Type	Additional information
ProspectId	integer	None.
DBAId	integer	None.
ProspectStatusId	byte	None.
TenantGroupStatusId	byte	None.
FirstName	string	None.
MiddleName	string	None.
LastName	string	None.
Email	string	None.
DaytimePhone	string	None.
EveningPhone	string	None.
Mobile	string	None.
OtherPhone	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
City	string	None.
StateId	byte	None.
Zip	string	None.
PresentCommunity	string	None.
ProspectLengthOfTenancyId	byte	None.
MonthlyRent	decimal number	None.
MoveOutReasonId	integer	None.
OtherReason	string	None.
TrafficSourceId	integer	None.
TrafficSourceCategoryId	integer	None.
ReferralTenantUnitId	integer	None.
IsReferralGetDiscount	boolean	None.
FirstContactTypeId	byte	None.
FirstContactLeasingAgentId	globally unique identifier	None.
FirstContactDate	date	None.
PriceRangeId	integer	None.
FloorLevelId	integer	None.
NumOfOccupants	integer	None.
NumOfPets	integer	None.
LeaseTermId	integer	None.
DateNeeded	date	None.
ReasonForNotRentId	integer	None.
PreferredUnitId	integer	None.
ProspectQuoteId	integer	None.
IsDuplicateRecord	boolean	None.
LastUpdatedBy	integer	None.
LastUpdatedDate	date	None.
OpenedBy	integer	None.
OpenedDate	date	None.
MoveToApplicantBy	integer	None.
MoveToApplicantDate	date	None.
ClosedBy	integer	None.
ClosedDate	date	None.
AppliedBy	integer	None.
AppliedDate	date	None.
ReopenBy	integer	None.
ReopenDate	date	None.
ApplicationSource	integer	None.
Preference1	integer	None.
Preference2	integer	None.
RecordedBy	integer	None.
RecordedDate	date	None.
ReferralUnitId	integer	None.
ReferralName	string	None.
IsLivingCommunityAcceptance	boolean	None.
prospectQuote	Collection of ProspectQuotesModel	None.

Response Formats

application/json, text/json

Sample:

{
  "prospectId": 1,
  "dbaId": 1,
  "prospectStatusId": 64,
  "tenantGroupStatusId": 64,
  "firstName": "sample string 3",
  "middleName": "sample string 4",
  "lastName": "sample string 5",
  "email": "sample string 6",
  "daytimePhone": "sample string 7",
  "eveningPhone": "sample string 8",
  "mobile": "sample string 9",
  "otherPhone": "sample string 10",
  "addressLine1": "sample string 11",
  "addressLine2": "sample string 12",
  "city": "sample string 13",
  "stateId": 64,
  "zip": "sample string 15",
  "presentCommunity": "sample string 16",
  "prospectLengthOfTenancyId": 64,
  "monthlyRent": 18.0,
  "moveOutReasonId": 1,
  "otherReason": "sample string 19",
  "trafficSourceId": 1,
  "trafficSourceCategoryId": 1,
  "referralTenantUnitId": 1,
  "isReferralGetDiscount": true,
  "firstContactTypeId": 64,
  "firstContactLeasingAgentId": "8d393eb3-c0a8-4343-ae6e-bd99e55087be",
  "firstContactDate": "2025-05-10T19:39:35.776117-05:00",
  "priceRangeId": 1,
  "floorLevelId": 1,
  "numOfOccupants": 1,
  "numOfPets": 1,
  "leaseTermId": 1,
  "dateNeeded": "2025-05-10T19:39:35.776117-05:00",
  "reasonForNotRentId": 1,
  "preferredUnitId": 1,
  "prospectQuoteId": 1,
  "isDuplicateRecord": true,
  "lastUpdatedBy": 25,
  "lastUpdatedDate": "2025-05-10T19:39:35.776117-05:00",
  "openedBy": 27,
  "openedDate": "2025-05-10T19:39:35.776117-05:00",
  "moveToApplicantBy": 29,
  "moveToApplicantDate": "2025-05-10T19:39:35.776117-05:00",
  "closedBy": 31,
  "closedDate": "2025-05-10T19:39:35.776117-05:00",
  "appliedBy": 33,
  "appliedDate": "2025-05-10T19:39:35.776117-05:00",
  "reopenBy": 35,
  "reopenDate": "2025-05-10T19:39:35.776117-05:00",
  "applicationSource": 37,
  "preference1": 1,
  "preference2": 1,
  "recordedBy": 38,
  "recordedDate": "2025-05-10T19:39:35.776117-05:00",
  "referralUnitId": 1,
  "referralName": "sample string 40",
  "isLivingCommunityAcceptance": true,
  "prospectQuote": [
    {
      "prospectQuoteId": 1,
      "prospectId": 1,
      "unitId": 1,
      "leaseStartDate": "2025-05-10T19:39:35.776117-05:00",
      "leaseTermId": 1,
      "leaseEndDate": "2025-05-10T19:39:35.776117-05:00",
      "generatedDate": "2025-05-10T19:39:35.776117-05:00",
      "generatedBy": 1,
      "expiryDate": "2025-05-10T19:39:35.776117-05:00",
      "netRent": 5.0,
      "applicationFee": 6.0,
      "administrativeFee": 7.0,
      "securityDeposit": 8.0,
      "monthlyRentPremium": 9.0,
      "weeklyRentPremium": 10.0,
      "dailyRentPremium": 11.0,
      "reportResult": "QEA=",
      "quoteNumber": "sample string 12",
      "dbaUnitTypeId": 1,
      "dbaId": 1,
      "managementCompanyId": 1,
      "tenantUnitId": 1,
      "amenities": [
        {
          "prospectId": 1,
          "prospectQuoteId": 1,
          "dbaRentalAmenityTypeId": 1,
          "dbaRentalAmenityType": "sample string 1",
          "quantity": 1,
          "nonRefundableFee": 1.0,
          "depositAmount": 1.0,
          "monthlyRent": 1.0,
          "nosAvailable": 1
        },
        {
          "prospectId": 1,
          "prospectQuoteId": 1,
          "dbaRentalAmenityTypeId": 1,
          "dbaRentalAmenityType": "sample string 1",
          "quantity": 1,
          "nonRefundableFee": 1.0,
          "depositAmount": 1.0,
          "monthlyRent": 1.0,
          "nosAvailable": 1
        }
      ],
      "pets": [
        {
          "prospectId": 1,
          "prospectQuoteId": 1,
          "dbaPetTypeId": 1,
          "dbaPetType": "sample string 1",
          "quantity": 1,
          "nonRefundableFee": 1.0,
          "depositAmount": 1.0,
          "monthlyRent": 1.0
        },
        {
          "prospectId": 1,
          "prospectQuoteId": 1,
          "dbaPetTypeId": 1,
          "dbaPetType": "sample string 1",
          "quantity": 1,
          "nonRefundableFee": 1.0,
          "depositAmount": 1.0,
          "monthlyRent": 1.0
        }
      ]
    },
    {
      "prospectQuoteId": 1,
      "prospectId": 1,
      "unitId": 1,
      "leaseStartDate": "2025-05-10T19:39:35.776117-05:00",
      "leaseTermId": 1,
      "leaseEndDate": "2025-05-10T19:39:35.776117-05:00",
      "generatedDate": "2025-05-10T19:39:35.776117-05:00",
      "generatedBy": 1,
      "expiryDate": "2025-05-10T19:39:35.776117-05:00",
      "netRent": 5.0,
      "applicationFee": 6.0,
      "administrativeFee": 7.0,
      "securityDeposit": 8.0,
      "monthlyRentPremium": 9.0,
      "weeklyRentPremium": 10.0,
      "dailyRentPremium": 11.0,
      "reportResult": "QEA=",
      "quoteNumber": "sample string 12",
      "dbaUnitTypeId": 1,
      "dbaId": 1,
      "managementCompanyId": 1,
      "tenantUnitId": 1,
      "amenities": [
        {
          "prospectId": 1,
          "prospectQuoteId": 1,
          "dbaRentalAmenityTypeId": 1,
          "dbaRentalAmenityType": "sample string 1",
          "quantity": 1,
          "nonRefundableFee": 1.0,
          "depositAmount": 1.0,
          "monthlyRent": 1.0,
          "nosAvailable": 1
        },
        {
          "prospectId": 1,
          "prospectQuoteId": 1,
          "dbaRentalAmenityTypeId": 1,
          "dbaRentalAmenityType": "sample string 1",
          "quantity": 1,
          "nonRefundableFee": 1.0,
          "depositAmount": 1.0,
          "monthlyRent": 1.0,
          "nosAvailable": 1
        }
      ],
      "pets": [
        {
          "prospectId": 1,
          "prospectQuoteId": 1,
          "dbaPetTypeId": 1,
          "dbaPetType": "sample string 1",
          "quantity": 1,
          "nonRefundableFee": 1.0,
          "depositAmount": 1.0,
          "monthlyRent": 1.0
        },
        {
          "prospectId": 1,
          "prospectQuoteId": 1,
          "dbaPetTypeId": 1,
          "dbaPetType": "sample string 1",
          "quantity": 1,
          "nonRefundableFee": 1.0,
          "depositAmount": 1.0,
          "monthlyRent": 1.0
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ProspectModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProspectId>1</ProspectId>
  <DBAId>1</DBAId>
  <ProspectStatusId>64</ProspectStatusId>
  <TenantGroupStatusId>64</TenantGroupStatusId>
  <FirstName>sample string 3</FirstName>
  <MiddleName>sample string 4</MiddleName>
  <LastName>sample string 5</LastName>
  <Email>sample string 6</Email>
  <DaytimePhone>sample string 7</DaytimePhone>
  <EveningPhone>sample string 8</EveningPhone>
  <Mobile>sample string 9</Mobile>
  <OtherPhone>sample string 10</OtherPhone>
  <AddressLine1>sample string 11</AddressLine1>
  <AddressLine2>sample string 12</AddressLine2>
  <City>sample string 13</City>
  <StateId>64</StateId>
  <Zip>sample string 15</Zip>
  <PresentCommunity>sample string 16</PresentCommunity>
  <ProspectLengthOfTenancyId>64</ProspectLengthOfTenancyId>
  <MonthlyRent>18</MonthlyRent>
  <MoveOutReasonId>1</MoveOutReasonId>
  <OtherReason>sample string 19</OtherReason>
  <TrafficSourceId>1</TrafficSourceId>
  <TrafficSourceCategoryId>1</TrafficSourceCategoryId>
  <ReferralTenantUnitId>1</ReferralTenantUnitId>
  <IsReferralGetDiscount>true</IsReferralGetDiscount>
  <FirstContactTypeId>64</FirstContactTypeId>
  <FirstContactLeasingAgentId>8d393eb3-c0a8-4343-ae6e-bd99e55087be</FirstContactLeasingAgentId>
  <FirstContactDate>2025-05-10T19:39:35.776117-05:00</FirstContactDate>
  <PriceRangeId>1</PriceRangeId>
  <FloorLevelId>1</FloorLevelId>
  <NumOfOccupants>1</NumOfOccupants>
  <NumOfPets>1</NumOfPets>
  <LeaseTermId>1</LeaseTermId>
  <DateNeeded>2025-05-10T19:39:35.776117-05:00</DateNeeded>
  <ReasonForNotRentId>1</ReasonForNotRentId>
  <PreferredUnitId>1</PreferredUnitId>
  <ProspectQuoteId>1</ProspectQuoteId>
  <IsDuplicateRecord>true</IsDuplicateRecord>
  <LastUpdatedBy>25</LastUpdatedBy>
  <LastUpdatedDate>2025-05-10T19:39:35.776117-05:00</LastUpdatedDate>
  <OpenedBy>27</OpenedBy>
  <OpenedDate>2025-05-10T19:39:35.776117-05:00</OpenedDate>
  <MoveToApplicantBy>29</MoveToApplicantBy>
  <MoveToApplicantDate>2025-05-10T19:39:35.776117-05:00</MoveToApplicantDate>
  <ClosedBy>31</ClosedBy>
  <ClosedDate>2025-05-10T19:39:35.776117-05:00</ClosedDate>
  <AppliedBy>33</AppliedBy>
  <AppliedDate>2025-05-10T19:39:35.776117-05:00</AppliedDate>
  <ReopenBy>35</ReopenBy>
  <ReopenDate>2025-05-10T19:39:35.776117-05:00</ReopenDate>
  <ApplicationSource>37</ApplicationSource>
  <Preference1>1</Preference1>
  <Preference2>1</Preference2>
  <RecordedBy>38</RecordedBy>
  <RecordedDate>2025-05-10T19:39:35.776117-05:00</RecordedDate>
  <ReferralUnitId>1</ReferralUnitId>
  <ReferralName>sample string 40</ReferralName>
  <IsLivingCommunityAcceptance>true</IsLivingCommunityAcceptance>
  <prospectQuote>
    <ProspectQuotesModel>
      <ProspectQuoteId>1</ProspectQuoteId>
      <ProspectId>1</ProspectId>
      <UnitId>1</UnitId>
      <LeaseStartDate>2025-05-10T19:39:35.776117-05:00</LeaseStartDate>
      <LeaseTermId>1</LeaseTermId>
      <LeaseEndDate>2025-05-10T19:39:35.776117-05:00</LeaseEndDate>
      <GeneratedDate>2025-05-10T19:39:35.776117-05:00</GeneratedDate>
      <GeneratedBy>1</GeneratedBy>
      <ExpiryDate>2025-05-10T19:39:35.776117-05:00</ExpiryDate>
      <NetRent>5</NetRent>
      <ApplicationFee>6</ApplicationFee>
      <AdministrativeFee>7</AdministrativeFee>
      <SecurityDeposit>8</SecurityDeposit>
      <MonthlyRentPremium>9</MonthlyRentPremium>
      <WeeklyRentPremium>10</WeeklyRentPremium>
      <DailyRentPremium>11</DailyRentPremium>
      <ReportResult>QEA=</ReportResult>
      <QuoteNumber>sample string 12</QuoteNumber>
      <DBAUnitTypeId>1</DBAUnitTypeId>
      <DBAId>1</DBAId>
      <ManagementCompanyId>1</ManagementCompanyId>
      <TenantUnitId>1</TenantUnitId>
      <Amenities>
        <AmenitiesAvailableModel>
          <ProspectId>1</ProspectId>
          <ProspectQuoteId>1</ProspectQuoteId>
          <DBARentalAmenityTypeId>1</DBARentalAmenityTypeId>
          <DBARentalAmenityType>sample string 1</DBARentalAmenityType>
          <Quantity>1</Quantity>
          <NonRefundableFee>1</NonRefundableFee>
          <DepositAmount>1</DepositAmount>
          <MonthlyRent>1</MonthlyRent>
          <NosAvailable>1</NosAvailable>
        </AmenitiesAvailableModel>
        <AmenitiesAvailableModel>
          <ProspectId>1</ProspectId>
          <ProspectQuoteId>1</ProspectQuoteId>
          <DBARentalAmenityTypeId>1</DBARentalAmenityTypeId>
          <DBARentalAmenityType>sample string 1</DBARentalAmenityType>
          <Quantity>1</Quantity>
          <NonRefundableFee>1</NonRefundableFee>
          <DepositAmount>1</DepositAmount>
          <MonthlyRent>1</MonthlyRent>
          <NosAvailable>1</NosAvailable>
        </AmenitiesAvailableModel>
      </Amenities>
      <Pets>
        <PetsAllowedModel>
          <ProspectId>1</ProspectId>
          <ProspectQuoteId>1</ProspectQuoteId>
          <DBAPetTypeId>1</DBAPetTypeId>
          <DBAPetType>sample string 1</DBAPetType>
          <Quantity>1</Quantity>
          <NonRefundableFee>1</NonRefundableFee>
          <DepositAmount>1</DepositAmount>
          <MonthlyRent>1</MonthlyRent>
        </PetsAllowedModel>
        <PetsAllowedModel>
          <ProspectId>1</ProspectId>
          <ProspectQuoteId>1</ProspectQuoteId>
          <DBAPetTypeId>1</DBAPetTypeId>
          <DBAPetType>sample string 1</DBAPetType>
          <Quantity>1</Quantity>
          <NonRefundableFee>1</NonRefundableFee>
          <DepositAmount>1</DepositAmount>
          <MonthlyRent>1</MonthlyRent>
        </PetsAllowedModel>
      </Pets>
    </ProspectQuotesModel>
    <ProspectQuotesModel>
      <ProspectQuoteId>1</ProspectQuoteId>
      <ProspectId>1</ProspectId>
      <UnitId>1</UnitId>
      <LeaseStartDate>2025-05-10T19:39:35.776117-05:00</LeaseStartDate>
      <LeaseTermId>1</LeaseTermId>
      <LeaseEndDate>2025-05-10T19:39:35.776117-05:00</LeaseEndDate>
      <GeneratedDate>2025-05-10T19:39:35.776117-05:00</GeneratedDate>
      <GeneratedBy>1</GeneratedBy>
      <ExpiryDate>2025-05-10T19:39:35.776117-05:00</ExpiryDate>
      <NetRent>5</NetRent>
      <ApplicationFee>6</ApplicationFee>
      <AdministrativeFee>7</AdministrativeFee>
      <SecurityDeposit>8</SecurityDeposit>
      <MonthlyRentPremium>9</MonthlyRentPremium>
      <WeeklyRentPremium>10</WeeklyRentPremium>
      <DailyRentPremium>11</DailyRentPremium>
      <ReportResult>QEA=</ReportResult>
      <QuoteNumber>sample string 12</QuoteNumber>
      <DBAUnitTypeId>1</DBAUnitTypeId>
      <DBAId>1</DBAId>
      <ManagementCompanyId>1</ManagementCompanyId>
      <TenantUnitId>1</TenantUnitId>
      <Amenities>
        <AmenitiesAvailableModel>
          <ProspectId>1</ProspectId>
          <ProspectQuoteId>1</ProspectQuoteId>
          <DBARentalAmenityTypeId>1</DBARentalAmenityTypeId>
          <DBARentalAmenityType>sample string 1</DBARentalAmenityType>
          <Quantity>1</Quantity>
          <NonRefundableFee>1</NonRefundableFee>
          <DepositAmount>1</DepositAmount>
          <MonthlyRent>1</MonthlyRent>
          <NosAvailable>1</NosAvailable>
        </AmenitiesAvailableModel>
        <AmenitiesAvailableModel>
          <ProspectId>1</ProspectId>
          <ProspectQuoteId>1</ProspectQuoteId>
          <DBARentalAmenityTypeId>1</DBARentalAmenityTypeId>
          <DBARentalAmenityType>sample string 1</DBARentalAmenityType>
          <Quantity>1</Quantity>
          <NonRefundableFee>1</NonRefundableFee>
          <DepositAmount>1</DepositAmount>
          <MonthlyRent>1</MonthlyRent>
          <NosAvailable>1</NosAvailable>
        </AmenitiesAvailableModel>
      </Amenities>
      <Pets>
        <PetsAllowedModel>
          <ProspectId>1</ProspectId>
          <ProspectQuoteId>1</ProspectQuoteId>
          <DBAPetTypeId>1</DBAPetTypeId>
          <DBAPetType>sample string 1</DBAPetType>
          <Quantity>1</Quantity>
          <NonRefundableFee>1</NonRefundableFee>
          <DepositAmount>1</DepositAmount>
          <MonthlyRent>1</MonthlyRent>
        </PetsAllowedModel>
        <PetsAllowedModel>
          <ProspectId>1</ProspectId>
          <ProspectQuoteId>1</ProspectQuoteId>
          <DBAPetTypeId>1</DBAPetTypeId>
          <DBAPetType>sample string 1</DBAPetType>
          <Quantity>1</Quantity>
          <NonRefundableFee>1</NonRefundableFee>
          <DepositAmount>1</DepositAmount>
          <MonthlyRent>1</MonthlyRent>
        </PetsAllowedModel>
      </Pets>
    </ProspectQuotesModel>
  </prospectQuote>
</ProspectModel>

GET api/Prospect/GetProspect/{id}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml

URI parameters

Headers | Add header

Body

Status

Headers

Body