GET api/tenants?name={name}&includeDisabled={includeDisabled}

Gets information about all tenants.

Request Information

URI Parameters

Name	Description	Type	Additional information
name	An optional parameter to find a tenant by name	string	None.
includeDisabled	An optional parameter to select whether or not to include disabled tenants.	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

Returns the details about the tenant.

Collection of Tenant

Name	Description	Type	Additional information
Id	Primary key for a tenant.	integer	None.
Name	The name of the tenant. This cannot be changed once the tenant has been created.	string	None.
Application	Gets or sets the type of application that is being used with this tenant (either PASS or NOVUS).	ParatransitApp	None.
ApplicationServiceUrl	Gets or sets the URL for the PASS/NOVUS Server Shell.	string	None.
DatabaseServer	Gets or sets the database server that the paratransit application database is hosted on.	string	None.
DatabaseName	Gets or sets the name of the paratransit application database.	string	None.
DatabaseUser	Gets or sets the SQL username used to connect to the database.	string	None.
DatabasePassword	Gets or sets the SQL password used to connect to the datdabase.	string	None.
AdminUsername	Gets or sets the default username to log into the system with.	string	None.
AdminPassword	Gets or sets the default password to log into the system with.	string	None.
TimeZone	Gets or sets the timezone of the DR application	string	None.
GoogleApiKey	Gets or sets the Google API key to use when making Google calls with a non-enterprise Google account Note that either this setting by itself, or the GoogleClientId and GoogleClientIdCryptoKey settings must be set	string	None.
GoogleClientId	Gets or sets the Google Client ID to use when making Google calls with an enterprise Google account Note that either this setting and the GoogleClientIdCryptoKey, or the GoogleApiKey by itself must be set	string	None.
GoogleClientIdCryptoKey	Gets or sets the Google Client ID Cryptographic Key to use when making Google calls with an enterprise Google account This setting is used when making non-javascript calls to Google's services. This key is used to encrypt the call so Google can verify the call is authorized. Note that either this setting and the GoogleClientId, or the GoogleApiKey by itself must be set	string	None.
RecaptchaSiteKey	Gets or sets the client-side key used for Google Recaptcha.	string	None.
RecaptchaSecretKey	Gets or sets the secret server-side key used for Google Recaptcha.	string	None.
Hosts	Gets or sets the list of host headers that map to this tenant.	Collection of TenantHost	None.
Filters	Gets or sets the list of filters that have been applied to this tenant. Trips and clients must match at least one filter in order to be included as a part of the tenant's data.	TenantFilters	None.
DatabaseType	The type of database used by the paratransit application	DatabaseType	None.
ExpiryDate	Gets or sets the expiry date of this tenant	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "name": "sample string 2",
    "application": 1,
    "applicationServiceUrl": "sample string 3",
    "databaseServer": "sample string 4",
    "databaseName": "sample string 5",
    "databaseUser": "sample string 6",
    "databasePassword": "sample string 7",
    "adminUsername": "sample string 8",
    "adminPassword": "sample string 9",
    "timeZone": "sample string 10",
    "googleApiKey": "sample string 11",
    "googleClientId": "sample string 12",
    "googleClientIdCryptoKey": "sample string 13",
    "recaptchaSiteKey": "sample string 14",
    "recaptchaSecretKey": "sample string 15",
    "hosts": [
      {
        "id": 1,
        "tenant": "sample string 2",
        "host": "sample string 3"
      },
      {
        "id": 1,
        "tenant": "sample string 2",
        "host": "sample string 3"
      }
    ],
    "filters": null,
    "databaseType": 0,
    "expiryDate": "2024-12-23T12:12:29.5196149-07:00"
  },
  {
    "id": 1,
    "name": "sample string 2",
    "application": 1,
    "applicationServiceUrl": "sample string 3",
    "databaseServer": "sample string 4",
    "databaseName": "sample string 5",
    "databaseUser": "sample string 6",
    "databasePassword": "sample string 7",
    "adminUsername": "sample string 8",
    "adminPassword": "sample string 9",
    "timeZone": "sample string 10",
    "googleApiKey": "sample string 11",
    "googleClientId": "sample string 12",
    "googleClientIdCryptoKey": "sample string 13",
    "recaptchaSiteKey": "sample string 14",
    "recaptchaSecretKey": "sample string 15",
    "hosts": [
      {
        "id": 1,
        "tenant": "sample string 2",
        "host": "sample string 3"
      },
      {
        "id": 1,
        "tenant": "sample string 2",
        "host": "sample string 3"
      }
    ],
    "filters": null,
    "databaseType": 0,
    "expiryDate": "2024-12-23T12:12:29.5196149-07:00"
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.