GET api/TenantScheduler/getTenant
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Tenant| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| AccessKey | string |
None. |
|
| WebClientUrl | string |
None. |
|
| ConnectionString | string |
None. |
|
| ServiceEndPoint | string |
None. |
|
| OfficeUsersCount | integer |
None. |
|
| RemoteUsersCount | integer |
None. |
|
| RateforOfficeUser | decimal number |
None. |
|
| RateforRemoteUser | decimal number |
None. |
|
| DepositAmount | decimal number |
None. |
|
| BillingCycle | string |
None. |
|
| BillingStartDate | date |
None. |
|
| ExpiryDate | date |
None. |
|
| Status | string |
None. |
|
| Prospect | Prospect |
None. |
|
| ConversionDate | date |
None. |
|
| ApplicationName | string |
None. |
|
| AccountId | integer |
None. |
|
| CompanyId | string |
None. |
|
| CreatedBy | string |
None. |
|
| CreatedOn | date |
None. |
Response Formats
application/json, text/json
Sample:
{
"id": "sample string 1",
"Name": "sample string 2",
"Logo": "sample string 3",
"AccountId": 4,
"InviteId": "sample string 5",
"StorageFolder": "sample string 6",
"Status": "sample string 7",
"CreatedOn": "2025-12-16T09:39:12.6630213+00:00",
"UpdatedOn": "2025-12-16T09:39:12.6630213+00:00",
"Companies": [
{
"Code": "sample string 1",
"Name": "sample string 2",
"FriendlyName": "sample string 3",
"Logo": "sample string 4",
"GenericFooter": "sample string 5",
"Address1": "sample string 6",
"Phone": "sample string 7",
"Status": "sample string 8",
"CheckInCheckOut": true,
"EnterHours": true,
"PiecemealPay": true,
"RoundUpTime": 12,
"InstallerRoundUpTime": 13,
"SalesmanRoundUpTime": 14,
"ShowInvoiceReason": true,
"Features": {
"Technician": true,
"Installer": true,
"Salesman": true,
"Survey": true,
"Dashboard": true,
"GPS": true,
"Schedular": true,
"TaskList": true,
"ViewUser": true,
"EditUser": true
},
"GoogleAccess": {
"access_token": "sample string 1",
"expires_in": 2,
"scope": "sample string 3",
"token_type": "sample string 4",
"id_token": "sample string 5",
"refresh_token": "sample string 6",
"expire_at": 7
}
},
{
"Code": "sample string 1",
"Name": "sample string 2",
"FriendlyName": "sample string 3",
"Logo": "sample string 4",
"GenericFooter": "sample string 5",
"Address1": "sample string 6",
"Phone": "sample string 7",
"Status": "sample string 8",
"CheckInCheckOut": true,
"EnterHours": true,
"PiecemealPay": true,
"RoundUpTime": 12,
"InstallerRoundUpTime": 13,
"SalesmanRoundUpTime": 14,
"ShowInvoiceReason": true,
"Features": {
"Technician": true,
"Installer": true,
"Salesman": true,
"Survey": true,
"Dashboard": true,
"GPS": true,
"Schedular": true,
"TaskList": true,
"ViewUser": true,
"EditUser": true
},
"GoogleAccess": {
"access_token": "sample string 1",
"expires_in": 2,
"scope": "sample string 3",
"token_type": "sample string 4",
"id_token": "sample string 5",
"refresh_token": "sample string 6",
"expire_at": 7
}
}
],
"DefaultPermissions": {
"Salesman": {
"ShowGrossTotals": true,
"SalesmanPersonalNotes": "sample string 2",
"sendSalesQuoteUsingSalesmanEmail": true,
"canAllowToChangeCouponAmount": true,
"canAllowToChangeCouponDescription": true
},
"Technician": {
"isFieldManager": true,
"canAllowToSearchSM": true,
"canAllowToCreateSM": true,
"canAllowToCreatePO": true,
"canAllowToCreateContracts": true,
"canAllowToBookCall": true,
"canAllowToRescheduleCall": true,
"canAllowToModifyEquipment": true,
"canAllowToDeleteEquipment": true,
"IsFreezeInvoiceAfterSingature": true,
"IsDefaultAMPMOnTime": true,
"canAllowToChangeTime": true,
"canAllowToCreateQuote": true,
"canAllowToModifyCallInfo": true,
"canAllowModifyCallInfo": true,
"canAllowSeeAllCalls": true,
"canAllowToBookCallFromQuote": true,
"needToUseTechEmailToSendServiceQuote": true,
"isChecklistRequired": true,
"requiredToAddWorkDescription": true,
"requiredToSelectEquipment": true,
"requiredAddSolutionCode": true,
"requiredAddPicture": true,
"requiredGiveAuthorizedWork": true,
"canAllowVideoCall": true,
"canAllowToVoidCreditCardTransaction": true,
"allowTipping": true,
"IsEmailRecommendation": true,
"IsEmailTechNotes": true,
"AllowManualCharge": true,
"TechBio": "sample string 31",
"EmailTos": [
{
"Email": "sample string 1",
"IsEmailRecommendationTo": true,
"IsEmailTechNotes": true
},
{
"Email": "sample string 1",
"IsEmailRecommendationTo": true,
"IsEmailTechNotes": true
}
]
},
"Installer": {
"IsManager": true,
"AllowToChargeCreditCard": true,
"AllowToVoidPayment": true,
"AllowToModifyTime": true,
"AllowToCreatePO": true,
"AllowToSearchJob": true,
"AllowToEnterJobMaterialList": true,
"AllowToEnterOTHours": true,
"AllowToEnterDTHours": true,
"AllowManualCharge": true
},
"TechnicianEmailCredential": {
"Email": "sample string 1",
"Password": "sample string 2",
"SMTP": "sample string 3"
}
},
"Features": {
"Technician": true,
"Installer": true,
"Salesman": true,
"Survey": true,
"Dashboard": true,
"GPS": true,
"Schedular": true,
"TaskList": true,
"ViewUser": true,
"EditUser": true
}
}
application/xml, text/xml
Sample:
<Tenant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SAWinProV4.Model.DTO.AddOn">
<AccountId>4</AccountId>
<Companies>
<Companies>
<Address1>sample string 6</Address1>
<CheckInCheckOut>true</CheckInCheckOut>
<Code>sample string 1</Code>
<EnterHours>true</EnterHours>
<Features>
<Dashboard>true</Dashboard>
<EditUser>true</EditUser>
<GPS>true</GPS>
<Installer>true</Installer>
<Salesman>true</Salesman>
<Schedular>true</Schedular>
<Survey>true</Survey>
<TaskList>true</TaskList>
<Technician>true</Technician>
<ViewUser>true</ViewUser>
</Features>
<FriendlyName>sample string 3</FriendlyName>
<GenericFooter>sample string 5</GenericFooter>
<GoogleAccess>
<access_token>sample string 1</access_token>
<expire_at>7</expire_at>
<expires_in>2</expires_in>
<id_token>sample string 5</id_token>
<refresh_token>sample string 6</refresh_token>
<scope>sample string 3</scope>
<token_type>sample string 4</token_type>
</GoogleAccess>
<InstallerRoundUpTime>13</InstallerRoundUpTime>
<Logo>sample string 4</Logo>
<Name>sample string 2</Name>
<Phone>sample string 7</Phone>
<PiecemealPay>true</PiecemealPay>
<RoundUpTime>12</RoundUpTime>
<SalesmanRoundUpTime>14</SalesmanRoundUpTime>
<ShowInvoiceReason>true</ShowInvoiceReason>
<Status>sample string 8</Status>
</Companies>
<Companies>
<Address1>sample string 6</Address1>
<CheckInCheckOut>true</CheckInCheckOut>
<Code>sample string 1</Code>
<EnterHours>true</EnterHours>
<Features>
<Dashboard>true</Dashboard>
<EditUser>true</EditUser>
<GPS>true</GPS>
<Installer>true</Installer>
<Salesman>true</Salesman>
<Schedular>true</Schedular>
<Survey>true</Survey>
<TaskList>true</TaskList>
<Technician>true</Technician>
<ViewUser>true</ViewUser>
</Features>
<FriendlyName>sample string 3</FriendlyName>
<GenericFooter>sample string 5</GenericFooter>
<GoogleAccess>
<access_token>sample string 1</access_token>
<expire_at>7</expire_at>
<expires_in>2</expires_in>
<id_token>sample string 5</id_token>
<refresh_token>sample string 6</refresh_token>
<scope>sample string 3</scope>
<token_type>sample string 4</token_type>
</GoogleAccess>
<InstallerRoundUpTime>13</InstallerRoundUpTime>
<Logo>sample string 4</Logo>
<Name>sample string 2</Name>
<Phone>sample string 7</Phone>
<PiecemealPay>true</PiecemealPay>
<RoundUpTime>12</RoundUpTime>
<SalesmanRoundUpTime>14</SalesmanRoundUpTime>
<ShowInvoiceReason>true</ShowInvoiceReason>
<Status>sample string 8</Status>
</Companies>
</Companies>
<CreatedOn>2025-12-16T09:39:12.6630213+00:00</CreatedOn>
<DefaultPermissions>
<Installer>
<AllowManualCharge>true</AllowManualCharge>
<AllowToChargeCreditCard>true</AllowToChargeCreditCard>
<AllowToCreatePO>true</AllowToCreatePO>
<AllowToEnterDTHours>true</AllowToEnterDTHours>
<AllowToEnterJobMaterialList>true</AllowToEnterJobMaterialList>
<AllowToEnterOTHours>true</AllowToEnterOTHours>
<AllowToModifyTime>true</AllowToModifyTime>
<AllowToSearchJob>true</AllowToSearchJob>
<AllowToVoidPayment>true</AllowToVoidPayment>
<IsManager>true</IsManager>
</Installer>
<Salesman>
<SalesmanPersonalNotes>sample string 2</SalesmanPersonalNotes>
<ShowGrossTotals>true</ShowGrossTotals>
<canAllowToChangeCouponAmount>true</canAllowToChangeCouponAmount>
<canAllowToChangeCouponDescription>true</canAllowToChangeCouponDescription>
<sendSalesQuoteUsingSalesmanEmail>true</sendSalesQuoteUsingSalesmanEmail>
</Salesman>
<Technician>
<AllowManualCharge>true</AllowManualCharge>
<EmailTos>
<EmailTo>
<Email>sample string 1</Email>
<IsEmailRecommendationTo>true</IsEmailRecommendationTo>
<IsEmailTechNotes>true</IsEmailTechNotes>
</EmailTo>
<EmailTo>
<Email>sample string 1</Email>
<IsEmailRecommendationTo>true</IsEmailRecommendationTo>
<IsEmailTechNotes>true</IsEmailTechNotes>
</EmailTo>
</EmailTos>
<IsDefaultAMPMOnTime>true</IsDefaultAMPMOnTime>
<IsEmailRecommendation>true</IsEmailRecommendation>
<IsEmailTechNotes>true</IsEmailTechNotes>
<IsFreezeInvoiceAfterSingature>true</IsFreezeInvoiceAfterSingature>
<TechBio>sample string 31</TechBio>
<allowTipping>true</allowTipping>
<canAllowModifyCallInfo>true</canAllowModifyCallInfo>
<canAllowSeeAllCalls>true</canAllowSeeAllCalls>
<canAllowToBookCall>true</canAllowToBookCall>
<canAllowToBookCallFromQuote>true</canAllowToBookCallFromQuote>
<canAllowToChangeTime>true</canAllowToChangeTime>
<canAllowToCreateContracts>true</canAllowToCreateContracts>
<canAllowToCreatePO>true</canAllowToCreatePO>
<canAllowToCreateQuote>true</canAllowToCreateQuote>
<canAllowToCreateSM>true</canAllowToCreateSM>
<canAllowToDeleteEquipment>true</canAllowToDeleteEquipment>
<canAllowToModifyCallInfo>true</canAllowToModifyCallInfo>
<canAllowToModifyEquipment>true</canAllowToModifyEquipment>
<canAllowToRescheduleCall>true</canAllowToRescheduleCall>
<canAllowToSearchSM>true</canAllowToSearchSM>
<canAllowToVoidCreditCardTransaction>true</canAllowToVoidCreditCardTransaction>
<canAllowVideoCall>true</canAllowVideoCall>
<isChecklistRequired>true</isChecklistRequired>
<isFieldManager>true</isFieldManager>
<needToUseTechEmailToSendServiceQuote>true</needToUseTechEmailToSendServiceQuote>
<requiredAddPicture>true</requiredAddPicture>
<requiredAddSolutionCode>true</requiredAddSolutionCode>
<requiredGiveAuthorizedWork>true</requiredGiveAuthorizedWork>
<requiredToAddWorkDescription>true</requiredToAddWorkDescription>
<requiredToSelectEquipment>true</requiredToSelectEquipment>
</Technician>
<TechnicianEmailCredential>
<Email>sample string 1</Email>
<Password>sample string 2</Password>
<SMTP>sample string 3</SMTP>
</TechnicianEmailCredential>
</DefaultPermissions>
<Features>
<Dashboard>true</Dashboard>
<EditUser>true</EditUser>
<GPS>true</GPS>
<Installer>true</Installer>
<Salesman>true</Salesman>
<Schedular>true</Schedular>
<Survey>true</Survey>
<TaskList>true</TaskList>
<Technician>true</Technician>
<ViewUser>true</ViewUser>
</Features>
<Id>sample string 1</Id>
<InviteId>sample string 5</InviteId>
<Logo>sample string 3</Logo>
<Name>sample string 2</Name>
<Status>sample string 7</Status>
<StorageFolder>sample string 6</StorageFolder>
<UpdatedOn>2025-12-16T09:39:12.6630213+00:00</UpdatedOn>
</Tenant>