Yardi · Schema

GetTenantsRequest

SOAP request for retrieving tenant data for a property.

AccountingCommercial Real EstateCoworkingInvestment ManagementMultifamilyProperty ManagementReal EstateResidentialSelf StorageSenior Living

Properties

Name Type Description
UserName string Yardi API user name
Password string Yardi API password
ServerName string Yardi database server name
Database string Yardi database name
Platform string Database platform identifier
YardiPropertyId string Yardi property identifier
InterfaceEntity string Interface entity code
InterfaceLicense string Interface license key
View JSON Schema on GitHub

JSON Schema

yardi-gettenantsrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetTenantsRequest",
  "title": "GetTenantsRequest",
  "type": "object",
  "description": "SOAP request for retrieving tenant data for a property.",
  "properties": {
    "UserName": {
      "type": "string",
      "description": "Yardi API user name"
    },
    "Password": {
      "type": "string",
      "description": "Yardi API password"
    },
    "ServerName": {
      "type": "string",
      "description": "Yardi database server name"
    },
    "Database": {
      "type": "string",
      "description": "Yardi database name"
    },
    "Platform": {
      "type": "string",
      "description": "Database platform identifier"
    },
    "YardiPropertyId": {
      "type": "string",
      "description": "Yardi property identifier"
    },
    "InterfaceEntity": {
      "type": "string",
      "description": "Interface entity code"
    },
    "InterfaceLicense": {
      "type": "string",
      "description": "Interface license key"
    }
  },
  "required": [
    "UserName",
    "Password",
    "ServerName",
    "Database",
    "Platform",
    "YardiPropertyId",
    "InterfaceEntity",
    "InterfaceLicense"
  ]
}