AccountAutoAuthentication
Retrieves Auto Authentication link for Account
API | Description |
---|---|
GET api/AccountAutoAuthentication/{ID}?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&IDPassword={IDPassword} |
Retrieves URL with GUID for account authorization using account ID and password ID for validationID PasswordURL with GUID for autoauthentication |
GET api/AccountAutoAuthentication/{ID}?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID} |
Retrieves URL with GUID for account authorization using API GUID and ID ID for validationURL with GUID for autoauthentication |
AccountSearch
API | Description |
---|---|
GET api/AccountSearch?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&PropertyAccessLevel={PropertyAccessLevel}&IncludeClosed={IncludeClosed}&FindUsing={FindUsing}&CompanyKey={CompanyKey} |
Retrieves account information using search criteria |
AccountSSO
Manages account SSO
API | Description |
---|---|
GET api/AccountSSO?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&SSOPosition={SSOPosition}&SSOGUID={SSOGUID} |
Get auto-authentication URL SSO field position for validation (1-6)GUID |
GET api/AccountSSO/{ID}?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&SSOPosition={SSOPosition}&IDPassword={IDPassword} |
Retrieves GUID for SSO authorization SSO field position for validation (1-6)ID for validationID Password |
APIGUID
Retrieves GUID for authorization for resident, employee or vendor, used when calling most of the REST APIs
API | Description |
---|---|
GET api/APIGUID/{ID}?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&IDPassword={IDPassword} |
No documentation available. |
APIGUIDAccount
Retrieves GUID for authorization for resident, used when calling most of the REST APIs
API | Description |
---|---|
GET api/APIGUIDAccount?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&accountID={accountID}&accountPassword={accountPassword} |
Retrieves GUID for account authorization |
APIGUIDAutoAuthenticator
Retrieves GUID for authorization using auto authenticator for resident, used when calling most of the REST APIs
APIGUIDEmployee
Retrieves GUID for employee authorization, used when calling most of the REST APIs
API | Description |
---|---|
GET api/APIGUIDEmployee?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&employeeID={employeeID}&employeePassword={employeePassword} |
Retrieves GUID for employee authorization |
APIGUIDVendor
Retrieves GUID for vendor authorization, used when calling most of the REST APIs
API | Description |
---|---|
GET api/APIGUIDVendor?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword} |
No documentation available. |
Architectural
Retrieves architecturals
API | Description |
---|---|
GET api/Architectural?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed} |
Get records for company or community |
GET api/Architectural?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed} |
Get records for unit |
POST api/Architectural?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
PUT api/Architectural?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
DELETE api/Architectural/{id} |
No documentation available. |
ArchitecturalNote
Retrieves architectural notes
BankSSO
Retrieves SSO URL for request bank
API | Description |
---|---|
GET api/BankSSO?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&SSOToken={SSOToken} |
No documentation available. |
BlastSearch
API | Description |
---|---|
POST api/BlastSearch?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
Searches for residents based on search criteria |
CallDetail
API | Description |
---|---|
GET api/CallDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&EmployeeKey={EmployeeKey}&PropertyAccessLevel={PropertyAccessLevel}&CallStatus={CallStatus} |
Retrieves open summary of requested task areas |
CallSummary
API | Description |
---|---|
GET api/CallSummary?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&EmployeeKey={EmployeeKey}&PropertyAccessLevel={PropertyAccessLevel} |
Retrieves open summary of requested task areas |
Committee
Manages Committee records
API | Description |
---|---|
GET api/Committee?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey} |
Retrieves list of committees |
CommitteeMember
Manages Committee Member records
API | Description |
---|---|
GET api/CommitteeMember?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CommitteeKey={CommitteeKey}&ResidentContactKey={ResidentContactKey} |
Retrieves list of committee members |
CommonCode
Retrieves list of defined commoncodes
API | Description |
---|---|
GET api/CommonCode?vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&Filter1={Filter1}&Filter2={Filter2} |
Retrieves list of defined commoncodes |
GET api/CommonCode?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&Filter1={Filter1} |
Retrieves list of defined commoncodes |
CommunicationRequest
Manages email processes
API | Description |
---|---|
POST api/CommunicationRequest?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&Mode={Mode} |
Sends communications |
CommuniqueAccount
Manages Bank Account statistics
CommuniqueProfitLoss
Manages Profit and Loss statistics
CommuniqueProperty
Manages Architectural, Compliance, Delinquency, Work Order
CommunityList
API | Description |
---|---|
GET api/CommunityList?vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey} |
Retrieves list of associated properties for passed GUID type |
CompanyDocument
Manages Company Document records
API | Description |
---|---|
GET api/CompanyDocument?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommitteeKey={CommitteeKey} |
Retrieves list of company documents |
GET api/CompanyDocument?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&DeltaDate={DeltaDate}&CompanyKey={CompanyKey} |
Retrieves list of company documents |
CompanyList
Retrieves list of communities
API | Description |
---|---|
GET api/CompanyList?vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID} |
Retrieves list of associated properties for passed GUID type |
GET api/CompanyList?vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&EmployeeKey={EmployeeKey} |
Retrieves list of associated properties for an employee |
GET api/CompanyList?vendorID={vendorID}&vendorPassword={vendorPassword}&VendorKey={VendorKey}&APIGUID={APIGUID} |
Retrieves list of associated properties for an vendor |
CompanyNote
Manages Company Note records
API | Description |
---|---|
GET api/CompanyNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyNoteKey={CompanyNoteKey} |
Get records for company or community |
POST api/CompanyNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
PUT api/CompanyNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
DELETE api/CompanyNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyNoteKey={CompanyNoteKey} |
No documentation available. |
CompanyNoteTask
Manages Company Note Task records
API | Description |
---|---|
GET api/CompanyNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyNoteKey={CompanyNoteKey}&CompanyNoteTaskKey={CompanyNoteTaskKey} |
Get records for company or community |
POST api/CompanyNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
PUT api/CompanyNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
DELETE api/CompanyNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyNoteTaskKey={CompanyNoteTaskKey} |
No documentation available. |
CompanyPortal
Retrieves SSO URL for request bank
API | Description |
---|---|
GET api/CompanyPortal?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey} |
Get Company Portal Information |
Compliance
API | Description |
---|---|
GET api/Compliance?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed} |
Get records for company or community |
GET api/Compliance?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed} |
Get records for unit |
POST api/Compliance?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
PUT api/Compliance?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
DELETE api/Compliance/{id} |
No documentation available. |
ComplianceCount
Retrieves open compliance count
API | Description |
---|---|
GET api/ComplianceCount?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey} |
No documentation available. |
ComplianceDefinition
Retrieves compliance definitions
API | Description |
---|---|
GET api/ComplianceDefinition?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey} |
Get records for unit |
ComplianceNote
API | Description |
---|---|
PUT api/ComplianceNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
Allows for a Put of a compliance sequence |
ComplianceSequence
Retrieves compliance notes
Document
Manages retrival of AP, architectual, compliance, company document, company note, account, collection vendor documents
API | Description |
---|---|
GET api/Document?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DocumentArea={DocumentArea}&DocumentKey={DocumentKey}&CompanyKey={CompanyKey}&AccountKey={AccountKey}&ResidentContactKey={ResidentContactKey}&BaseURL={BaseURL}&OutputType={OutputType}&Filename={Filename} |
Get DocumentArea Architectural = 1 AP = 6 APNote = 10 APTask = 11 CompanyDocument = 4 CompanyNote = 5 CompanyNoteTask = 9 Compliance = 2 Resident = 3 ResidentTask = 12 ResidentCollection = 7 Vendor = 8 --BaseURL-- URL of web service --OutputType-- URL or FILE |
Documents
Manages retrival of architectual and compliance documents for a parent key
EmailManagement
API | Description |
---|---|
GET api/EmailManagement?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentNoteKey={ResidentNoteKey} |
Retrieves list of available HTML templates |
EmailMethod
Manages system records
API | Description |
---|---|
GET api/EmailMethod?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
Retrieves information about email method |
Employee
API | Description |
---|---|
GET api/Employee?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&EmployeeKey={EmployeeKey} |
Retrieves employee information |
EmployeeKey
API | Description |
---|---|
GET api/EmployeeKey?validationKey={validationKey}&partnerKey={partnerKey}&vendorID={vendorID}&vendorPassword={vendorPassword}&employeeID={employeeID}&employeePassword={employeePassword} |
Validates passed employee, with returned EmployeeKey |
EmployeeList
API | Description |
---|---|
GET api/EmployeeList?vendorID={vendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey} |
No documentation available. |
GeneralLedgerAccountInformation
Manages Profit and Loss statistics
HTMLManagement
API | Description |
---|---|
GET api/HTMLManagement?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&EmployeeKey={EmployeeKey}&CompanyKey={CompanyKey} |
Retrieves list of available HTML templates |
GET api/HTMLManagement?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&HTMLTemplateName={HTMLTemplateName}&CompanyKey={CompanyKey} |
Retrieves the HTML content of the request filename |
POST api/HTMLManagement?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
Adds HTML template to folder |
MergeDocument
Create merge document
API | Description |
---|---|
GET api/MergeDocument?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DocumentListArea={DocumentListArea}&FileName={FileName}&RecordKey={RecordKey} |
No documentation available. |
MergeDocumentList
Request List of Merge Templates
API | Description |
---|---|
GET api/MergeDocumentList?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DocumentListArea={DocumentListArea} |
Get list of available merge templates |
MultiLink
Portal
Retrieves SSO URL for request bank
API | Description |
---|---|
GET api/Portal?VendorID={VendorID}&VendorPassword={VendorPassword} |
Get VMSTeamConnect portal settings |
Resident
API | Description |
---|---|
GET api/Resident?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&ResidentKey={ResidentKey} |
Retrieves resident data |
GET api/Resident?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DeltaDate={DeltaDate}&CompanyKey={CompanyKey}&ResidentKey={ResidentKey} |
Get unit delta records for resident |
ResidentAccountType
Retrieves list of defined resident account types
API | Description |
---|---|
GET api/ResidentAccountType?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID} |
Retrieves list of Resident Acount Types |
ResidentContact
API | Description |
---|---|
GET api/ResidentContact?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}&ResidentContactKey={ResidentContactKey} |
Retrieves resident contact data |
GET api/ResidentContact?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DeltaDate={DeltaDate}&CompanyKey={CompanyKey} |
Get unit delta records for resident contact |
ResidentLinkedAccount
API | Description |
---|---|
GET api/ResidentLinkedAccount?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey} |
Retrieves all resident sub accounts |
ResidentNote
API | Description |
---|---|
GET api/ResidentNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentKey={ResidentKey}&IncludeClosed={IncludeClosed} |
Retrieves resident notes |
GET api/ResidentNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentNoteKey={ResidentNoteKey} |
No documentation available. |
POST api/ResidentNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
PUT api/ResidentNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
DELETE api/ResidentNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentNoteKey={ResidentNoteKey} |
No documentation available. |
ResidentNoteTask
API | Description |
---|---|
GET api/ResidentNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentNoteKey={ResidentNoteKey} |
Retrieves resident note task data |
POST api/ResidentNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
PUT api/ResidentNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
DELETE api/ResidentNoteTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentNoteTaskKey={ResidentNoteTaskKey} |
No documentation available. |
ResidentPaymentLink
API | Description |
---|---|
GET api/ResidentPaymentLink?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&ResidentContactKey={ResidentContactKey} |
Retrieves payment links for resident contact |
Rule
Retrieves compliance rules
API | Description |
---|---|
GET api/Rule?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey} |
No documentation available. |
RulePicklist
Retrieves compliance rules picklist
API | Description |
---|---|
GET api/RulePicklist?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey} |
No documentation available. |
SetAccountHash
Manage resident contact record
TaskDetail
API | Description |
---|---|
GET api/TaskDetail?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&RequestTaskAreasBit={RequestTaskAreasBit}&PropertyAccessLevel={PropertyAccessLevel} |
Retrieves open details of requested task areas |
TaskSummary
API | Description |
---|---|
GET api/TaskSummary?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&RequestTaskAreasBit={RequestTaskAreasBit}&PropertyAccessLevel={PropertyAccessLevel} |
Retrieves open summary of requested task areas |
Unit
Retrieves units
API | Description |
---|---|
GET api/Unit?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey} |
Get unit records for company or community. Code will add GEO tab information to unit if google API key is in web.config file |
GET api/Unit?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&DeltaDate={DeltaDate}&CompanyKey={CompanyKey} |
Get delta records for unit. Code will add GEO tab information to unit if google API key is in web.config file |
UserProfile
Retrieves User Profile
API | Description |
---|---|
GET api/UserProfile?validationKey={validationKey}&partnerKey={partnerKey}&VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
VendorSecurity
Retrieves Vendor Secuirty Rights
API | Description |
---|---|
GET api/VendorSecurity?validationKey={validationKey}&partnerKey={partnerKey}&VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey} |
No documentation available. |
VMSControl
API | Description |
---|---|
GET api/VMSControl?VendorID={VendorID}&vendorPassword={vendorPassword}&APIGUID={APIGUID} |
Retrieves VMSControl record |
WebURL
Retrieves list of URLS for company
API | Description |
---|---|
GET api/WebURL?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey} |
Retrieves list of URLs for company |
WorkOrder
API | Description |
---|---|
GET api/WorkOrder?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey}&CommunityKey={CommunityKey}&IncludeClosed={IncludeClosed} |
No documentation available. |
GET api/WorkOrder?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&UnitKey={UnitKey}&IncludeClosed={IncludeClosed} |
No documentation available. |
POST api/WorkOrder?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
PUT api/WorkOrder?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
WorkOrderDetail
WorkOrderItem
API | Description |
---|---|
GET api/WorkOrderItem?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&CompanyKey={CompanyKey} |
No documentation available. |
WorkOrderNote
API | Description |
---|---|
GET api/WorkOrderNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&VendorPayKey={VendorPayKey}&Imagebit={Imagebit} |
No documentation available. |
POST api/WorkOrderNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
PUT api/WorkOrderNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
DELETE api/WorkOrderNote?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&VendorPayNoteKey={VendorPayNoteKey} |
No documentation available. |
WorkOrderTask
API | Description |
---|---|
GET api/WorkOrderTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&VendorPayKey={VendorPayKey} |
Retrieves open summary of requested task areas |
POST api/WorkOrderTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
PUT api/WorkOrderTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID} |
No documentation available. |
DELETE api/WorkOrderTask?VendorID={VendorID}&VendorPassword={VendorPassword}&APIGUID={APIGUID}&VendorPayTaskKey={VendorPayTaskKey} |
No documentation available. |