POST 17.0/database/tenancytenants/list

Description

Retrieve a list of Tenancy Tenants

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of TenancyTenantsUpdate
Name Description Type Additional information
TenancyID

integer

None.
ContactID

integer

None.
PaymentMethodID

integer

None.
PaymentDay

byte

None.
PaymentDayBenefit

byte

None.
PaymentFrequency

byte

None.
PaymentFrequencyBenefit

byte

None.
Amount

decimal number

None.
AmountBenefit

decimal number

None.
Deposit

decimal number

None.
AdditionalAmount

decimal number

None.
AdditionalProductID

integer

None.
TDSTenantID

string

String length: inclusive between 0 and 25

application/json, text/json
Sample: 
[
  {
    "tenancyID": 1,
    "contactID": 1,
    "paymentMethodID": 1,
    "paymentDay": 64,
    "paymentDayBenefit": 64,
    "paymentFrequency": 64,
    "paymentFrequencyBenefit": 64,
    "amount": 1.0,
    "amountBenefit": 1.0,
    "deposit": 1.0,
    "additionalAmount": 1.0,
    "additionalProductID": 1,
    "tdsTenantID": "sample string 1"
  },
  {
    "tenancyID": 1,
    "contactID": 1,
    "paymentMethodID": 1,
    "paymentDay": 64,
    "paymentDayBenefit": 64,
    "paymentFrequency": 64,
    "paymentFrequencyBenefit": 64,
    "amount": 1.0,
    "amountBenefit": 1.0,
    "deposit": 1.0,
    "additionalAmount": 1.0,
    "additionalProductID": 1,
    "tdsTenantID": "sample string 1"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfTenancyTenantsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TenancyTenantsUpdate>
    <TenancyID>1</TenancyID>
    <ContactID>1</ContactID>
    <PaymentMethodID>1</PaymentMethodID>
    <PaymentDay>64</PaymentDay>
    <PaymentDayBenefit>64</PaymentDayBenefit>
    <PaymentFrequency>64</PaymentFrequency>
    <PaymentFrequencyBenefit>64</PaymentFrequencyBenefit>
    <Amount>1</Amount>
    <AmountBenefit>1</AmountBenefit>
    <Deposit>1</Deposit>
    <AdditionalAmount>1</AdditionalAmount>
    <AdditionalProductID>1</AdditionalProductID>
    <TDSTenantID>sample string 1</TDSTenantID>
  </TenancyTenantsUpdate>
  <TenancyTenantsUpdate>
    <TenancyID>1</TenancyID>
    <ContactID>1</ContactID>
    <PaymentMethodID>1</PaymentMethodID>
    <PaymentDay>64</PaymentDay>
    <PaymentDayBenefit>64</PaymentDayBenefit>
    <PaymentFrequency>64</PaymentFrequency>
    <PaymentFrequencyBenefit>64</PaymentFrequencyBenefit>
    <Amount>1</Amount>
    <AmountBenefit>1</AmountBenefit>
    <Deposit>1</Deposit>
    <AdditionalAmount>1</AdditionalAmount>
    <AdditionalProductID>1</AdditionalProductID>
    <TDSTenantID>sample string 1</TDSTenantID>
  </TenancyTenantsUpdate>
</ArrayOfTenancyTenantsUpdate>