GET v1/xpresscollect/{facilityId}/tenant/{tenantPmsId}/unit/{unitId}

Gets the xpress collect tenant.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
facilityId

The facility identifier.

 globally unique identifier

Required
tenantPmsId

The tenant PMS identifier.

 string

Required
unitId

The unit identifier.

 string

Required

Body Parameters

None.

Response Information

Resource Description

GetXpressCollectTenantResult
NameDescriptionTypeAdditional information
Tenant

XpressCollectFacilityTenantItem

None.
Errors

Collection of Exception

None.
IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Tenant": {
    "FacilityId": "9f6af4db-ec38-47d9-9b37-a4d1a2943d04",
    "FacilityName": "sample string 2",
    "IssnFacilityTenantId": "5a9e7d68-e0eb-4c34-b1e5-913ffa384b74",
    "PMSTenantId": "sample string 4",
    "TenantFirstName": "sample string 5",
    "TenantLastName": "sample string 6",
    "TenantName": "sample string 7",
    "TenantCellPhone": "sample string 8",
    "UnitId": "sample string 9",
    "UnitName": "sample string 10",
    "TenantEmail": "sample string 11",
    "UnitBalanceDue": 12.1,
    "UnitPaidThru": "2025-10-25T11:55:50.3815136-07:00",
    "DaysLate": 14,
    "InBankruptcy": true,
    "EmailBlacklisted": true,
    "SmsBlacklisted": true,
    "TwilioPhoneNumber": "sample string 18",
    "UnitType": "sample string 19",
    "LastPTDUpdated": "2025-10-25T11:55:50.3815136-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: 
<GetXpressCollectTenantResult 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>
  <Tenant>
    <DaysLate>14</DaysLate>
    <EmailBlacklisted>true</EmailBlacklisted>
    <FacilityId>9f6af4db-ec38-47d9-9b37-a4d1a2943d04</FacilityId>
    <FacilityName>sample string 2</FacilityName>
    <InBankruptcy>true</InBankruptcy>
    <IssnFacilityTenantId>5a9e7d68-e0eb-4c34-b1e5-913ffa384b74</IssnFacilityTenantId>
    <LastPTDUpdated>2025-10-25T11:55:50.3815136-07:00</LastPTDUpdated>
    <PMSTenantId>sample string 4</PMSTenantId>
    <SmsBlacklisted>true</SmsBlacklisted>
    <TenantCellPhone>sample string 8</TenantCellPhone>
    <TenantEmail>sample string 11</TenantEmail>
    <TenantFirstName>sample string 5</TenantFirstName>
    <TenantLastName>sample string 6</TenantLastName>
    <TenantName>sample string 7</TenantName>
    <TwilioPhoneNumber>sample string 18</TwilioPhoneNumber>
    <UnitBalanceDue>12.1</UnitBalanceDue>
    <UnitId>sample string 9</UnitId>
    <UnitName>sample string 10</UnitName>
    <UnitPaidThru>2025-10-25T11:55:50.3815136-07:00</UnitPaidThru>
    <UnitType>sample string 19</UnitType>
  </Tenant>
</GetXpressCollectTenantResult>