GET api/v{version}/tenantinfo
Gets information about the current tenant.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| version |
The requested API version |
string |
Required Default value is 2.0 |
Body Parameters
None.
Response Information
Resource Description
Returns details about the tenant, including its name, paratransit application type, and timezone offset information.
TenantInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| Name |
Gets or sets the name of the tenant. |
string |
None. |
| Application |
Gets or sets the paratransit application that is used in the back end. |
ParatransitApp |
None. |
| UTCOffset |
The offset from UTC time at the current time (in minutes) |
integer |
None. |
| WindowsTimeZone |
The windows time zone ID of the tenant |
string |
None. |
| ID |
The database ID of the tenant |
integer |
None. |
Response Formats
application/json, text/json, application/problem+json
Sample:
{
"name": "TenantName",
"application": 2,
"utcOffset": -240,
"windowsTimeZone": "Eastern Standard Time",
"id": 0
}
application/xml, text/xml
Sample:
<TenantInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TS.DR.Resources"> <Application>Novus</Application> <ID>0</ID> <Name>TenantName</Name> <UTCOffset>-240</UTCOffset> <WindowsTimeZone>Eastern Standard Time</WindowsTimeZone> </TenantInfo>