GET api/Applicant/GetListByEligiblieforScreening/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

ApplicationScreeningModel

Name	Type	Additional information
CurrentRent	decimal number	None.
UnitNumber	string	None.
TrafficSource	string	None.
ApplicationPreScreening	integer	None.
applicants	Collection of ApplicantModel	None.

Response Formats

application/json, text/json

Sample:

{
  "currentRent": 1.0,
  "unitNumber": "sample string 2",
  "trafficSource": "sample string 3",
  "applicationPreScreening": 4,
  "applicants": [
    {
      "tempApplicantId": 1,
      "applicantId": 2,
      "otherApplicantUserId": 3,
      "applicantTypeId": 64,
      "spouseId": 1,
      "applicationId": 1,
      "applicantName": "sample string 5",
      "firstName": "sample string 6",
      "middleName": "sample string 7",
      "lastName": "sample string 8",
      "dateOfBirth": "2025-05-10T19:40:40.4752592-05:00",
      "genderId": 64,
      "maritalStatusId": 64,
      "maritalStatus": "sample string 12",
      "applicantType": "sample string 13",
      "heightId": 1,
      "weight": 1.1,
      "eyeColorId": 64,
      "hairColorId": 64,
      "usCitizen": true,
      "isSmoker": true,
      "addressLine1": "sample string 18",
      "addressLine2": "sample string 19",
      "city": "sample string 20",
      "stateId": 64,
      "zip": "sample string 22",
      "email": "sample string 23",
      "daytimePhone": "sample string 24",
      "eveningPhone": "sample string 25",
      "mobile": "sample string 26",
      "otherPhone": "sample string 27",
      "ssn": "sample string 28",
      "dlStateId": 64,
      "dlNumber": "sample string 30",
      "internationalIdentityTypeId": 64,
      "internationalIdentityNumber": "sample string 32",
      "internationalAddressLine1": "sample string 33",
      "internationalAddressLine2": "sample string 34",
      "internationalCounty": "sample string 35",
      "internationalCity": "sample string 36",
      "internationalState": "sample string 37",
      "internationalCountry": "sample string 38",
      "internationalZip": "sample string 39",
      "internationalPhone": "sample string 40",
      "isActive": true,
      "displayNameOnLeaseDocument": true,
      "inactivatedBy": 43,
      "inactivatedDate": "2025-05-10T19:40:40.4752592-05:00",
      "lastUpdatedBy": 45,
      "lastUpdatedDate": "2025-05-10T19:40:40.4752592-05:00",
      "streetNumber": 1,
      "streetName": "sample string 47",
      "doNoHaveSSN": true,
      "guarantorId": 49,
      "applicantGuarantor": 50,
      "screeningStatusId": 51,
      "unitApplicationId": 52,
      "screeningResult": "sample string 53",
      "isScreened": true,
      "screeningResultId": 55,
      "grossMonthlyIncome": 56.0,
      "age": 57,
      "state": "sample string 58",
      "dlState": "sample string 59",
      "identifier": "124c378e-c9dc-4fa7-8b47-7104f26bcc5a",
      "isNew": true,
      "trafficSourceId": 1,
      "trafficSourceCategoryId": 1,
      "referralTenantUnitId": 1,
      "referralUnitId": 1,
      "prospectId": 62,
      "referralName": "sample string 63",
      "emergencycontact": {
        "applicantEmergencyContactId": 1,
        "applicantId": 1,
        "firstName": "sample string 1",
        "middleName": "sample string 2",
        "lastName": "sample string 3",
        "addressLine1": "sample string 4",
        "addressLine2": "sample string 5",
        "city": "sample string 6",
        "stateId": 64,
        "zip": "sample string 8",
        "daytimePhone": "sample string 9",
        "eveningPhone": "sample string 10",
        "mobile": "sample string 11",
        "email": "sample string 12",
        "relationship": "sample string 13",
        "ecAbovePerson": true,
        "ecParentOrChild": true,
        "ecSpouse": true,
        "residentSpecialNeedsExists": true,
        "residentSpecialNeedsDesc": "sample string 14",
        "isActive": true,
        "inActivatedDate": "2025-05-10T19:40:40.4752592-05:00",
        "inActivatedBy": 1,
        "lastUpdatedDate": "2025-05-10T19:40:40.4752592-05:00",
        "lastUpdatedBy": 1
      }
    },
    {
      "tempApplicantId": 1,
      "applicantId": 2,
      "otherApplicantUserId": 3,
      "applicantTypeId": 64,
      "spouseId": 1,
      "applicationId": 1,
      "applicantName": "sample string 5",
      "firstName": "sample string 6",
      "middleName": "sample string 7",
      "lastName": "sample string 8",
      "dateOfBirth": "2025-05-10T19:40:40.4752592-05:00",
      "genderId": 64,
      "maritalStatusId": 64,
      "maritalStatus": "sample string 12",
      "applicantType": "sample string 13",
      "heightId": 1,
      "weight": 1.1,
      "eyeColorId": 64,
      "hairColorId": 64,
      "usCitizen": true,
      "isSmoker": true,
      "addressLine1": "sample string 18",
      "addressLine2": "sample string 19",
      "city": "sample string 20",
      "stateId": 64,
      "zip": "sample string 22",
      "email": "sample string 23",
      "daytimePhone": "sample string 24",
      "eveningPhone": "sample string 25",
      "mobile": "sample string 26",
      "otherPhone": "sample string 27",
      "ssn": "sample string 28",
      "dlStateId": 64,
      "dlNumber": "sample string 30",
      "internationalIdentityTypeId": 64,
      "internationalIdentityNumber": "sample string 32",
      "internationalAddressLine1": "sample string 33",
      "internationalAddressLine2": "sample string 34",
      "internationalCounty": "sample string 35",
      "internationalCity": "sample string 36",
      "internationalState": "sample string 37",
      "internationalCountry": "sample string 38",
      "internationalZip": "sample string 39",
      "internationalPhone": "sample string 40",
      "isActive": true,
      "displayNameOnLeaseDocument": true,
      "inactivatedBy": 43,
      "inactivatedDate": "2025-05-10T19:40:40.4752592-05:00",
      "lastUpdatedBy": 45,
      "lastUpdatedDate": "2025-05-10T19:40:40.4752592-05:00",
      "streetNumber": 1,
      "streetName": "sample string 47",
      "doNoHaveSSN": true,
      "guarantorId": 49,
      "applicantGuarantor": 50,
      "screeningStatusId": 51,
      "unitApplicationId": 52,
      "screeningResult": "sample string 53",
      "isScreened": true,
      "screeningResultId": 55,
      "grossMonthlyIncome": 56.0,
      "age": 57,
      "state": "sample string 58",
      "dlState": "sample string 59",
      "identifier": "124c378e-c9dc-4fa7-8b47-7104f26bcc5a",
      "isNew": true,
      "trafficSourceId": 1,
      "trafficSourceCategoryId": 1,
      "referralTenantUnitId": 1,
      "referralUnitId": 1,
      "prospectId": 62,
      "referralName": "sample string 63",
      "emergencycontact": {
        "applicantEmergencyContactId": 1,
        "applicantId": 1,
        "firstName": "sample string 1",
        "middleName": "sample string 2",
        "lastName": "sample string 3",
        "addressLine1": "sample string 4",
        "addressLine2": "sample string 5",
        "city": "sample string 6",
        "stateId": 64,
        "zip": "sample string 8",
        "daytimePhone": "sample string 9",
        "eveningPhone": "sample string 10",
        "mobile": "sample string 11",
        "email": "sample string 12",
        "relationship": "sample string 13",
        "ecAbovePerson": true,
        "ecParentOrChild": true,
        "ecSpouse": true,
        "residentSpecialNeedsExists": true,
        "residentSpecialNeedsDesc": "sample string 14",
        "isActive": true,
        "inActivatedDate": "2025-05-10T19:40:40.4752592-05:00",
        "inActivatedBy": 1,
        "lastUpdatedDate": "2025-05-10T19:40:40.4752592-05:00",
        "lastUpdatedBy": 1
      }
    }
  ]
}

application/xml, text/xml

Sample:

<ApplicationScreeningModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentRent>1</CurrentRent>
  <UnitNumber>sample string 2</UnitNumber>
  <TrafficSource>sample string 3</TrafficSource>
  <ApplicationPreScreening>4</ApplicationPreScreening>
  <applicants>
    <ApplicantModel>
      <TempApplicantId>1</TempApplicantId>
      <ApplicantId>2</ApplicantId>
      <OtherApplicantUserId>3</OtherApplicantUserId>
      <ApplicantTypeId>64</ApplicantTypeId>
      <SpouseId>1</SpouseId>
      <ApplicationId>1</ApplicationId>
      <ApplicantName>sample string 5</ApplicantName>
      <FirstName>sample string 6</FirstName>
      <MiddleName>sample string 7</MiddleName>
      <LastName>sample string 8</LastName>
      <DateOfBirth>2025-05-10T19:40:40.4752592-05:00</DateOfBirth>
      <GenderId>64</GenderId>
      <MaritalStatusId>64</MaritalStatusId>
      <MaritalStatus>sample string 12</MaritalStatus>
      <ApplicantType>sample string 13</ApplicantType>
      <HeightId>1</HeightId>
      <Weight>1.1</Weight>
      <EyeColorId>64</EyeColorId>
      <HairColorId>64</HairColorId>
      <USCitizen>true</USCitizen>
      <IsSmoker>true</IsSmoker>
      <AddressLine1>sample string 18</AddressLine1>
      <AddressLine2>sample string 19</AddressLine2>
      <City>sample string 20</City>
      <StateId>64</StateId>
      <Zip>sample string 22</Zip>
      <Email>sample string 23</Email>
      <DaytimePhone>sample string 24</DaytimePhone>
      <EveningPhone>sample string 25</EveningPhone>
      <Mobile>sample string 26</Mobile>
      <OtherPhone>sample string 27</OtherPhone>
      <SSN>sample string 28</SSN>
      <DLStateId>64</DLStateId>
      <DLNumber>sample string 30</DLNumber>
      <InternationalIdentityTypeId>64</InternationalIdentityTypeId>
      <InternationalIdentityNumber>sample string 32</InternationalIdentityNumber>
      <InternationalAddressLine1>sample string 33</InternationalAddressLine1>
      <InternationalAddressLine2>sample string 34</InternationalAddressLine2>
      <InternationalCounty>sample string 35</InternationalCounty>
      <InternationalCity>sample string 36</InternationalCity>
      <InternationalState>sample string 37</InternationalState>
      <InternationalCountry>sample string 38</InternationalCountry>
      <InternationalZip>sample string 39</InternationalZip>
      <InternationalPhone>sample string 40</InternationalPhone>
      <IsActive>true</IsActive>
      <DisplayNameOnLeaseDocument>true</DisplayNameOnLeaseDocument>
      <InactivatedBy>43</InactivatedBy>
      <InactivatedDate>2025-05-10T19:40:40.4752592-05:00</InactivatedDate>
      <LastUpdatedBy>45</LastUpdatedBy>
      <LastUpdatedDate>2025-05-10T19:40:40.4752592-05:00</LastUpdatedDate>
      <StreetNumber>1</StreetNumber>
      <StreetName>sample string 47</StreetName>
      <DoNoHaveSSN>true</DoNoHaveSSN>
      <GuarantorId>49</GuarantorId>
      <ApplicantGuarantor>50</ApplicantGuarantor>
      <ScreeningStatusId>51</ScreeningStatusId>
      <UnitApplicationId>52</UnitApplicationId>
      <ScreeningResult>sample string 53</ScreeningResult>
      <IsScreened>true</IsScreened>
      <ScreeningResultId>55</ScreeningResultId>
      <GrossMonthlyIncome>56</GrossMonthlyIncome>
      <Age>57</Age>
      <State>sample string 58</State>
      <DLState>sample string 59</DLState>
      <Identifier>124c378e-c9dc-4fa7-8b47-7104f26bcc5a</Identifier>
      <IsNew>true</IsNew>
      <TrafficSourceId>1</TrafficSourceId>
      <TrafficSourceCategoryId>1</TrafficSourceCategoryId>
      <ReferralTenantUnitId>1</ReferralTenantUnitId>
      <ReferralUnitId>1</ReferralUnitId>
      <ProspectId>62</ProspectId>
      <ReferralName>sample string 63</ReferralName>
      <emergencycontact>
        <ApplicantEmergencyContactId>1</ApplicantEmergencyContactId>
        <ApplicantId>1</ApplicantId>
        <FirstName>sample string 1</FirstName>
        <MiddleName>sample string 2</MiddleName>
        <LastName>sample string 3</LastName>
        <AddressLine1>sample string 4</AddressLine1>
        <AddressLine2>sample string 5</AddressLine2>
        <City>sample string 6</City>
        <StateId>64</StateId>
        <Zip>sample string 8</Zip>
        <DaytimePhone>sample string 9</DaytimePhone>
        <EveningPhone>sample string 10</EveningPhone>
        <Mobile>sample string 11</Mobile>
        <Email>sample string 12</Email>
        <Relationship>sample string 13</Relationship>
        <ECAbovePerson>true</ECAbovePerson>
        <ECParentOrChild>true</ECParentOrChild>
        <ECSpouse>true</ECSpouse>
        <ResidentSpecialNeedsExists>true</ResidentSpecialNeedsExists>
        <ResidentSpecialNeedsDesc>sample string 14</ResidentSpecialNeedsDesc>
        <IsActive>true</IsActive>
        <InActivatedDate>2025-05-10T19:40:40.4752592-05:00</InActivatedDate>
        <InActivatedBy>1</InActivatedBy>
        <LastUpdatedDate>2025-05-10T19:40:40.4752592-05:00</LastUpdatedDate>
        <LastUpdatedBy>1</LastUpdatedBy>
      </emergencycontact>
    </ApplicantModel>
    <ApplicantModel>
      <TempApplicantId>1</TempApplicantId>
      <ApplicantId>2</ApplicantId>
      <OtherApplicantUserId>3</OtherApplicantUserId>
      <ApplicantTypeId>64</ApplicantTypeId>
      <SpouseId>1</SpouseId>
      <ApplicationId>1</ApplicationId>
      <ApplicantName>sample string 5</ApplicantName>
      <FirstName>sample string 6</FirstName>
      <MiddleName>sample string 7</MiddleName>
      <LastName>sample string 8</LastName>
      <DateOfBirth>2025-05-10T19:40:40.4752592-05:00</DateOfBirth>
      <GenderId>64</GenderId>
      <MaritalStatusId>64</MaritalStatusId>
      <MaritalStatus>sample string 12</MaritalStatus>
      <ApplicantType>sample string 13</ApplicantType>
      <HeightId>1</HeightId>
      <Weight>1.1</Weight>
      <EyeColorId>64</EyeColorId>
      <HairColorId>64</HairColorId>
      <USCitizen>true</USCitizen>
      <IsSmoker>true</IsSmoker>
      <AddressLine1>sample string 18</AddressLine1>
      <AddressLine2>sample string 19</AddressLine2>
      <City>sample string 20</City>
      <StateId>64</StateId>
      <Zip>sample string 22</Zip>
      <Email>sample string 23</Email>
      <DaytimePhone>sample string 24</DaytimePhone>
      <EveningPhone>sample string 25</EveningPhone>
      <Mobile>sample string 26</Mobile>
      <OtherPhone>sample string 27</OtherPhone>
      <SSN>sample string 28</SSN>
      <DLStateId>64</DLStateId>
      <DLNumber>sample string 30</DLNumber>
      <InternationalIdentityTypeId>64</InternationalIdentityTypeId>
      <InternationalIdentityNumber>sample string 32</InternationalIdentityNumber>
      <InternationalAddressLine1>sample string 33</InternationalAddressLine1>
      <InternationalAddressLine2>sample string 34</InternationalAddressLine2>
      <InternationalCounty>sample string 35</InternationalCounty>
      <InternationalCity>sample string 36</InternationalCity>
      <InternationalState>sample string 37</InternationalState>
      <InternationalCountry>sample string 38</InternationalCountry>
      <InternationalZip>sample string 39</InternationalZip>
      <InternationalPhone>sample string 40</InternationalPhone>
      <IsActive>true</IsActive>
      <DisplayNameOnLeaseDocument>true</DisplayNameOnLeaseDocument>
      <InactivatedBy>43</InactivatedBy>
      <InactivatedDate>2025-05-10T19:40:40.4752592-05:00</InactivatedDate>
      <LastUpdatedBy>45</LastUpdatedBy>
      <LastUpdatedDate>2025-05-10T19:40:40.4752592-05:00</LastUpdatedDate>
      <StreetNumber>1</StreetNumber>
      <StreetName>sample string 47</StreetName>
      <DoNoHaveSSN>true</DoNoHaveSSN>
      <GuarantorId>49</GuarantorId>
      <ApplicantGuarantor>50</ApplicantGuarantor>
      <ScreeningStatusId>51</ScreeningStatusId>
      <UnitApplicationId>52</UnitApplicationId>
      <ScreeningResult>sample string 53</ScreeningResult>
      <IsScreened>true</IsScreened>
      <ScreeningResultId>55</ScreeningResultId>
      <GrossMonthlyIncome>56</GrossMonthlyIncome>
      <Age>57</Age>
      <State>sample string 58</State>
      <DLState>sample string 59</DLState>
      <Identifier>124c378e-c9dc-4fa7-8b47-7104f26bcc5a</Identifier>
      <IsNew>true</IsNew>
      <TrafficSourceId>1</TrafficSourceId>
      <TrafficSourceCategoryId>1</TrafficSourceCategoryId>
      <ReferralTenantUnitId>1</ReferralTenantUnitId>
      <ReferralUnitId>1</ReferralUnitId>
      <ProspectId>62</ProspectId>
      <ReferralName>sample string 63</ReferralName>
      <emergencycontact>
        <ApplicantEmergencyContactId>1</ApplicantEmergencyContactId>
        <ApplicantId>1</ApplicantId>
        <FirstName>sample string 1</FirstName>
        <MiddleName>sample string 2</MiddleName>
        <LastName>sample string 3</LastName>
        <AddressLine1>sample string 4</AddressLine1>
        <AddressLine2>sample string 5</AddressLine2>
        <City>sample string 6</City>
        <StateId>64</StateId>
        <Zip>sample string 8</Zip>
        <DaytimePhone>sample string 9</DaytimePhone>
        <EveningPhone>sample string 10</EveningPhone>
        <Mobile>sample string 11</Mobile>
        <Email>sample string 12</Email>
        <Relationship>sample string 13</Relationship>
        <ECAbovePerson>true</ECAbovePerson>
        <ECParentOrChild>true</ECParentOrChild>
        <ECSpouse>true</ECSpouse>
        <ResidentSpecialNeedsExists>true</ResidentSpecialNeedsExists>
        <ResidentSpecialNeedsDesc>sample string 14</ResidentSpecialNeedsDesc>
        <IsActive>true</IsActive>
        <InActivatedDate>2025-05-10T19:40:40.4752592-05:00</InActivatedDate>
        <InActivatedBy>1</InActivatedBy>
        <LastUpdatedDate>2025-05-10T19:40:40.4752592-05:00</LastUpdatedDate>
        <LastUpdatedBy>1</LastUpdatedBy>
      </emergencycontact>
    </ApplicantModel>
  </applicants>
</ApplicationScreeningModel>

GET api/Applicant/GetListByEligiblieforScreening/{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