GET v1/facilities/{id}/findtenant?FirstName={FirstName}&LastName={LastName}&Address={Address}&City={City}&PostalCode={PostalCode}&Phone={Phone}&Email={Email}&GateCode={GateCode}&UnitName={UnitName}&AcrossAccount={AcrossAccount}

Gets the tenants by search criteria.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The identifier.

globally unique identifier

Required

FirstName

string

None.

LastName

string

None.

Address

string

None.

City

string

None.

PostalCode

string

None.

Phone

string

None.

Email

string

None.

GateCode

string

None.

UnitName

string

None.

AcrossAccount

string

None.

Body Parameters

None.

Response Information

Resource Description

FacilityTenants
NameDescriptionTypeAdditional information
FacilityTenantsList

Collection of FacilityTenantItem

None.

Errors

Collection of Exception

None.

IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "FacilityTenantsList": [
    {
      "Id": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "Street1": "sample string 5",
      "Street2": "sample string 6",
      "City": "sample string 7",
      "StateOrProv": "sample string 8",
      "PostalCode": "sample string 9",
      "HomePhone": "sample string 10",
      "WorkPhone": "sample string 11",
      "CellPhone": "sample string 12",
      "EmailAddress": "sample string 13",
      "GateAccessCode": "sample string 14",
      "UnitId": "sample string 15",
      "UnitName": "sample string 16",
      "UnitPaidThruDate": "2021-10-18T09:31:57.316249-07:00",
      "UnitBalanceDue": 18.1,
      "UnitRentalRate": 1.1,
      "BillingPeriod": "sample string 19",
      "LastPTDUpdated": "2021-10-18T09:31:57.316249-07:00",
      "OverLocked": "sample string 20",
      "GateLocked": "sample string 21",
      "MovedInDate": "2021-10-18T09:31:57.316249-07:00",
      "ExpectedVacateDate": "2021-10-18T09:31:57.316249-07:00",
      "NextRentAssessmentDate": "2021-10-18T09:31:57.316249-07:00"
    },
    {
      "Id": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4",
      "Street1": "sample string 5",
      "Street2": "sample string 6",
      "City": "sample string 7",
      "StateOrProv": "sample string 8",
      "PostalCode": "sample string 9",
      "HomePhone": "sample string 10",
      "WorkPhone": "sample string 11",
      "CellPhone": "sample string 12",
      "EmailAddress": "sample string 13",
      "GateAccessCode": "sample string 14",
      "UnitId": "sample string 15",
      "UnitName": "sample string 16",
      "UnitPaidThruDate": "2021-10-18T09:31:57.316249-07:00",
      "UnitBalanceDue": 18.1,
      "UnitRentalRate": 1.1,
      "BillingPeriod": "sample string 19",
      "LastPTDUpdated": "2021-10-18T09:31:57.316249-07:00",
      "OverLocked": "sample string 20",
      "GateLocked": "sample string 21",
      "MovedInDate": "2021-10-18T09:31:57.316249-07:00",
      "ExpectedVacateDate": "2021-10-18T09:31:57.316249-07:00",
      "NextRentAssessmentDate": "2021-10-18T09:31:57.316249-07:00"
    }
  ],
  "Errors": [
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    }
  ],
  "IsSuccess": true
}

application/xml, text/xml

Sample:
<FacilityTenants xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
    <d2p1:Exception>
      <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName>
      <Message i:nil="true" xmlns="" />
      <Data i:nil="true" xmlns="" />
      <InnerException i:nil="true" xmlns="" />
      <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL>
      <StackTraceString i:nil="true" xmlns="" />
      <RemoteStackTraceString i:nil="true" xmlns="" />
      <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex>
      <ExceptionMethod i:nil="true" xmlns="" />
      <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult>
      <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source>
      <WatsonBuckets i:nil="true" xmlns="" />
    </d2p1:Exception>
  </Errors>
  <IsSuccess>true</IsSuccess>
  <FacilityTenantsList>
    <FacilityTenantItem>
      <BillingPeriod>sample string 19</BillingPeriod>
      <CellPhone>sample string 12</CellPhone>
      <City>sample string 7</City>
      <EmailAddress>sample string 13</EmailAddress>
      <ExpectedVacateDate>2021-10-18T09:31:57.316249-07:00</ExpectedVacateDate>
      <FirstName>sample string 2</FirstName>
      <GateAccessCode>sample string 14</GateAccessCode>
      <GateLocked>sample string 21</GateLocked>
      <HomePhone>sample string 10</HomePhone>
      <Id>sample string 1</Id>
      <LastName>sample string 4</LastName>
      <LastPTDUpdated>2021-10-18T09:31:57.316249-07:00</LastPTDUpdated>
      <MiddleName>sample string 3</MiddleName>
      <MovedInDate>2021-10-18T09:31:57.316249-07:00</MovedInDate>
      <NextRentAssessmentDate>2021-10-18T09:31:57.316249-07:00</NextRentAssessmentDate>
      <OverLocked>sample string 20</OverLocked>
      <PostalCode>sample string 9</PostalCode>
      <StateOrProv>sample string 8</StateOrProv>
      <Street1>sample string 5</Street1>
      <Street2>sample string 6</Street2>
      <UnitBalanceDue>18.1</UnitBalanceDue>
      <UnitId>sample string 15</UnitId>
      <UnitName>sample string 16</UnitName>
      <UnitPaidThruDate>2021-10-18T09:31:57.316249-07:00</UnitPaidThruDate>
      <UnitRentalRate>1.1</UnitRentalRate>
      <WorkPhone>sample string 11</WorkPhone>
    </FacilityTenantItem>
    <FacilityTenantItem>
      <BillingPeriod>sample string 19</BillingPeriod>
      <CellPhone>sample string 12</CellPhone>
      <City>sample string 7</City>
      <EmailAddress>sample string 13</EmailAddress>
      <ExpectedVacateDate>2021-10-18T09:31:57.316249-07:00</ExpectedVacateDate>
      <FirstName>sample string 2</FirstName>
      <GateAccessCode>sample string 14</GateAccessCode>
      <GateLocked>sample string 21</GateLocked>
      <HomePhone>sample string 10</HomePhone>
      <Id>sample string 1</Id>
      <LastName>sample string 4</LastName>
      <LastPTDUpdated>2021-10-18T09:31:57.316249-07:00</LastPTDUpdated>
      <MiddleName>sample string 3</MiddleName>
      <MovedInDate>2021-10-18T09:31:57.316249-07:00</MovedInDate>
      <NextRentAssessmentDate>2021-10-18T09:31:57.316249-07:00</NextRentAssessmentDate>
      <OverLocked>sample string 20</OverLocked>
      <PostalCode>sample string 9</PostalCode>
      <StateOrProv>sample string 8</StateOrProv>
      <Street1>sample string 5</Street1>
      <Street2>sample string 6</Street2>
      <UnitBalanceDue>18.1</UnitBalanceDue>
      <UnitId>sample string 15</UnitId>
      <UnitName>sample string 16</UnitName>
      <UnitPaidThruDate>2021-10-18T09:31:57.316249-07:00</UnitPaidThruDate>
      <UnitRentalRate>1.1</UnitRentalRate>
      <WorkPhone>sample string 11</WorkPhone>
    </FacilityTenantItem>
  </FacilityTenantsList>
</FacilityTenants>