UnitType

Unit Type Controller

APIDescription
DELETE v1/facilities/{facilityId}/unittype

Deletes the PMS unit type.

POST v1/facilities/{facilityId}/unittype

Updates the PMS unit type.

Unit

Unit Controller

APIDescription
POST v1/facilities/{facilityId}/unit/{unitPmsId}

Updates the PMS unit.

DELETE v1/facilities/{facilityId}/unit/{unitPmsId}

Deletes the PMS unit.

TwilioCallRouting

Twilio Call Routing Controller

APIDescription
POST v1/Calling/InitiateCall

Initiates a phone call.

Blacklist

Blacklist Controller

APIDescription
POST v1/Blacklist/UpdateBlacklist

Updates the blacklist.

GET v1/Blacklist/GetBlacklist/{facilityId}

Gets the blacklist.

POST v1/Blacklist/SmsResponseHandling

SMS response handling.

GET v1/Blacklist/{facilityId}/SendEmailOptInInstructions/{issnTenantId}

Sends the email opt in instructions.

GET v1/Blacklist/{facilityId}/EmailOptOutLink/{issnTenantId}

The email opt out link.

ApplicationLogging

APIDescription
POST v1/applicationlogging/logevent

No documentation available.

ShortUrl

Short Url Controller

APIDescription
POST v1/shorturl/create

Creates the short URL.

GET v1/shorturl/{linkId}/full/{type}

Gets the redirection URL.

GET v1/shorturl/{linkId}/isexpired/{type}

Determines whether the specified link identifier is expired.

Schedule

Schedule Controller

APIDescription
POST v1/schedule/{facilityId}/tenantsms

Sends the tenant SMS.

POST v1/schedule/{facilityId}/tenantemail

Sends the tenant email.

GET v1/schedule

Gets the scheduled tasks.

GET v1/schedule/xpresscollect

Gets the xpress collect tasks.

GET v1/schedule/xpresscollect/{facilityId}

Gets the xpress collect facility tasks.

GET v1/schedule/xpresscollect/{facilityId}/clear

Clears the facility tasks.

GET v1/schedule/xpresscollect/clear

Clears the xpress collect tasks.

GET v1/schedule/clear/{jobId}

Clears the task.

GET v1/schedule/xpresscollect/forceschedule

Forces the schedule xpress collect primary job.

POST v1/schedule/email

Sends the tenant email.

GET v1/schedule/xpresscollect/stats?day={day}

Gets the xpress collect message stats.

GET v1/schedule/xpresscollect/prevented?start={start}&end={end}

Gets the xpress collect prevented messages.

GET v1/schedule/xpresscollect/runjob/{runInDays}

Runs the xpress collect job.

GET v1/schedule/xpresscollect/{facilityId}/runjob/{runInDays}

Runs the xpress collect job.

Facilities

Facilities Controller

APIDescription
GET v1/facilities/byaccount/{accountId}

Gets the account facilities for web API user.

GET v1/facilities

Gets the facilities.

GET v2/GetFacilityByIdNoPms/{facilityId}

No documentation available.

GET v1/facilities?id={id}

Gets the specified facility.

GET v1/facilities/{id}/fees

Gets the facility fees.

GET v1/facilities/{id}/insurance

Gets the facility insurance.

GET v1/facilities/{id}/marketingsources

Gets the facility marketing sources.

GET v1/facilities/{id}/merchandise

Gets the facility merchandise list.

GET v1/facilities/{id}/specials

Gets the facility move in specials.

GET v1/facilities/{fId}/promotions?utId={utId}

Gets the facility promos.

GET v1/facilities/{id}/tenantsXDaysOut/{daysOut}/getCurrentTenants

No documentation available.

GET v1/facilities/{id}/tenants?useCache={useCache}

Gets the facility tenants.

GET v1/facilities/{id}/tenantsptd?useCache={useCache}

Gets the facility tenants paid to dates.

GET v1/facilities/{id}/findtenant?FirstName={FirstName}&LastName={LastName}&Address={Address}&City={City}&PostalCode={PostalCode}&Phone={Phone}&Email={Email}&GateCode={GateCode}&UnitName={UnitName}&AcrossAccount={AcrossAccount}

Gets the tenants by search criteria.

GET v1/facilities/{id}/unittypes

Gets the facility unit types.

GET v1/facilities/{facilityId}/unitgroups

No documentation available.

GET v1/facilities/{fId}/unittypes/{utId}/units

Gets the available units for a unit type.

GET v1/facilities/{fId}/groupstypesunits/{useCacheOnly}

No documentation available.

GET v1/facilities/{fId}/unittypes/{utId}/allunits

Gets the all units for a unit type.

GET v1/facilities/{fId}/units

Gets the facility all units.

POST v1/facilities/{fId}/processbluemoonlease

Processes the bluemoon lease.

GET v1/facilities/{fId}/tenant/{tId}/getreservationcharges?UnitId={UnitId}&PromoId={PromoId}&InsuranceId={InsuranceId}&Pin={Pin}&PayMonths={PayMonths}

Gets the tenant reserved charges.

POST v1/facilities/{fId}/tenant/{tId}/modifyreservation

Processes the tenant reservation modification.

POST v1/facilities/{fId}/tenant/{tId}/processreservationfulfillment

Processes the tenant reservation fulfillment.

GET v1/facilities/{fId}/getmoveincost?UnitId={UnitId}&UnitName={UnitName}&TenantId={TenantId}&TenantPin={TenantPin}&UnitTypeId={UnitTypeId}&UnitTypeDescription={UnitTypeDescription}&PromotionId={PromotionId}&CouponCode={CouponCode}&InsuranceId={InsuranceId}&ForDate={ForDate}&CustomRate={CustomRate}

Gets the move in cost.

POST v1/facilities/{fId}/processtenantmovein

Processes the tenant move in.

GET v1/facilities/{fId}/getsmtpsettings

Gets the facility SMTP settings.

GET v1/facilities/{fId}/getEsignPreviewURL/{unitId}

Get Esign Preview URL for a facilities unit.

GET v1/facilities/{fId}/getEsignCreateLeaseURL?AccountId={AccountId}&UnitId={UnitId}&ReturnURL={ReturnURL}

Gets the facility esign create lease URL.

GET v1/facilities/{id}/auctionInformation

Gets the facility auction information.

GET v1/facilities/{cisId}/GetId

Gets the facility identifier from cis identifier.

POST v1/Facilities

Resolves the geo point from location.

StcSurvey

Stc Survey Controller

APIDescription
POST v1/STC/Survey/forceRun

Forces the run email survey job.

InsomniacOnline

INSOMNIAC Online Controller

APIDescription
GET v1/insomniaconline/{facilityId}/paymentsettings/basic

Gets the basic payment options.

GET v1/insomniaconline/{facilityId}/staticleasevariables?onlineSettingsId={onlineSettingsId}

Gets the static lease variables.

Tenants

Tenants Controller

APIDescription
GET v1/facilities/{facilityId}/tenants/{tenantId}/charges?TenantPin={TenantPin}&TenantFirstName={TenantFirstName}&TenantLastName={TenantLastName}&UnitId={UnitId}&UnitName={UnitName}&PayPeriods={PayPeriods}&IsConvenienceFeeAdded={IsConvenienceFeeAdded}&ConvenienceFeeOrName={ConvenienceFeeOrName}

Gets the tenant's charges.

GET v2/facilities/{facilityId}/tenants/{tenantId}/charges?TenantPin={TenantPin}&TenantFirstName={TenantFirstName}&TenantLastName={TenantLastName}&UnitId={UnitId}&UnitName={UnitName}&PayPeriods={PayPeriods}&IsConvenienceFeeAdded={IsConvenienceFeeAdded}&ConvenienceFeeOrName={ConvenienceFeeOrName}

No documentation available.

GET v2/facilities/{facilityId}/tenant?tenantId={tenantId}&tenantPin={tenantPin}&unitName={unitName}&phoneLast4={phoneLast4}&lastName={lastName}

No documentation available.

GET v1/facilities/{facilityId}/tenants/{tenantId}?tenantPin={tenantPin}

Gets the tenant information.

POST v2/facilities/{facilityId}/tenant/{tenantId}/image

No documentation available.

GET v1/facilities/{facilityId}/tenants/{tenantId}/payinfo?TenantPin={TenantPin}&UnitId={UnitId}

Gets the tenant's on file pay information.

GET v1/facilities/{facilityId}/tenants/{tenantId}/units?TenantPin={TenantPin}

Gets the tentant's units.

POST v1/tenants/{id}/payments

Posts a tenant payment.

GET v1/tenants/interac?OrderId={OrderId}&FacilityId={FacilityId}&CisId={CisId}&LinkoutId={LinkoutId}&TenantId={TenantId}&RequestType={RequestType}&PaymentMethod={PaymentMethod}&CustomerName={CustomerName}&CustomerEmailAddress={CustomerEmailAddress}&CustomerPhoneNumber={CustomerPhoneNumber}&ContactPhoneNumber={ContactPhoneNumber}&CustomerAddress1={CustomerAddress1}&CustomerAddress2={CustomerAddress2}&CustomerCity={CustomerCity}&CustomerProvince={CustomerProvince}&CustomerPostalCode={CustomerPostalCode}&CustomerCountry={CustomerCountry}&Number={Number}&Price={Price}&ExpiryMonth={ExpiryMonth}&ExpiryYear={ExpiryYear}&CVDCode={CVDCode}&ApprovedPage={ApprovedPage}&DeclinedPage={DeclinedPage}&PaymentPageLanguage={PaymentPageLanguage}

Gets the interac payment URL.

GET v1/tenants/interac/getresult/{orderId}/facilityId/{facilityId}

Gets the interac payment result.

GET v1/tenants/interac/getresult/{orderId}/cisId/{cisId}

Gets the interac payment result.

GET v1/tenants/interac/updateresult/{orderId}/facility/{facilityId}/{isSuccess}

Updates the interac payment result.

GET v1/facilities/{facilityId}/tenants/{tenantId}/payhistory

Gets the tenant history of payments.

GET v1/facilities/{facilityId}/tenants/{tenantId}/chargehistory

Gets the tenant history of charges.

GET v1/facilities/{facilityId}/tenants/{tenantId}/notes

Gets the tenant notes.

POST v1/facilities/{facilityId}/tenants/{tenantId}/notes

Updates the tenant note.

GET v1/tenants/verifycard?creditCardNumber={creditCardNumber}

Verifies the tenant credit card.

POST v1/facilities/{facilityId}/tenants/{tenantId}/updatepayinfo

Updates the facility tenant on file pay information.

POST v1/facilities/{facilityId}/tenants/processmerchandisesale

Processes the merchandise sale.

GET v1/facilities/{facilityId}/tenants/getreservationbyphone?phoneNumber={phoneNumber}&lastName={lastName}

Gets the tenant reservation by phone number.

GET v2/facilities/{facilityId}/tenants/GetTenantInfoWithReservationByPhoneNumber?phoneNumber={phoneNumber}&lastName={lastName}

No documentation available.

GET v1/facilities/{facilityId}/tenant/{pmsTenantId}/consumerId

Gets the tenants consumer identifier.

POST v1/facilities/{facilityId}/tenant/{tenantPmsId}

Updates the PMS tenant.

DELETE v1/facilities/{facilityId}/tenant/{tenantPmsId}

Deletes the PMS tenant.

vCard

APIDescription
GET v1/facilities/{facilityId}/vcard/getCardData

Gets the facilities virtual card.

POST v1/facilities/{facilityId}/vcard/createCard

Inserts the facility virtual card.

POST v1/facilities/{facilityId}/vcard/updateCard

Updates the facilities virtual card.

DocumentManagement

Facility Document Managment Controller

APIDescription
POST v1/facilities/{facilityId}/savedocument

Saves the document.

GET v1/facilities/{facilityId}/getdocument/{documentId}

Gets the document.

GET v1/facilities/{facilityId}/getall

Gets all facility documents.

PmsMatrix

Property Management System Feature Matrix Controller

APIDescription
GET v1/pmsmatrix/{facilityId}

Gets the facility PMS features.

CrmAccounts

Microsoft CRM Accounts Controller

APIDescription
GET v1/crmaccounts/openportaluser/{id}

Gets the accounts by openportal user.

GET v1/crmaccounts

Gets the accounts for IssnWebApi user .

XpressCollect

XpressCollect Controller

APIDescription
GET v1/xpresscollect/accounts/all

Gets all xpress collect accounts.

POST v1/xpresscollect/facilities

Gets the xpress collect facilities by account.

GET v1/xpresscollect/facilities/all

Gets all xpress collect facilities.

GET v1/xpresscollect/{facilityId}/settings

Gets the xpress collect facility settings.

PUT v1/xpresscollect/{facilityId}/settings

Updates the xpress collect facility settings.

GET v1/xpresscollect/{facilityId}/documenttemplates

Gets the xpress collect facility document templates.

GET v1/xpresscollect/{facilityId}/holidays

Gets the xpress collect facility holidays.

PUT v1/xpresscollect/{facilityId}/holiday

Update the xpress collect facility Holiday.

DELETE v1/xpresscollect/{facilityId}/holiday

Deletes the xpress collect facility Holiday.

POST v1/xpresscollect/{facilityId}/holiday

Inserts the xpress collect facility Holiday.

GET v1/xpresscollect/{facilityId}/availablestandardholidays

Gets the xpress collect facility available standard holidays.

GET v1/xpresscollect/{facilityId}/tenants

Gets the xpress collect facility tenants.

GET v1/xpresscollect/{facilityId}/scheduledmessages

Gets the xpress collect facility scheduled messages.

PUT v1/xpresscollect/{facilityId}/scheduledmessage

Updates the xpress collect facility scheduled message.

DELETE v1/xpresscollect/{facilityId}/scheduledmessage

Deletes the xpress collect facility scheduled message.

POST v1/xpresscollect/{facilityId}/scheduledmessage

Inserts the xpress collect facility scheduled message.

PUT v1/xpresscollect/settings/{facilityId}/updateactivestatus

Updates the xpress collect facility active status.

GET v1/xpresscollect/{facilityId}/custommessages

Gets the xpress collect facility custom messages.

PUT v1/xpresscollect/{facilityId}/custommessage

Updates the xpress collect facility custom message.

DELETE v1/xpresscollect/{facilityId}/custommessage

Deletes the xpress collect facility custom message.

POST v1/xpresscollect/{facilityId}/custommessage

Inserts the xpress collect facility custom message.

PUT v1/xpresscollect/{facilityId}/tenants/{issnFacilityTenantId}/exclusions

Updates the xpress collect facility tenant bankruptcy setting.

GET v1/xpresscollect/templatevariables

Gets the xpress collect template variables.

GET v1/xpresscollect/{facilityId}/custommessage/{customMessageId}/email?issnTenantId={issnTenantId}&tenantEmail={tenantEmail}&openPortalUserName={openPortalUserName}

Sends the custom message email.

POST v1/xpresscollect/{facilityId}/sendmessage/email

Sends the message email.

POST v1/xpresscollect/{facilityId}/sendmessage/sms

Sends the message SMS.

GET v1/xpresscollect/{facilityId}/custommessage/{customMessageId}/sms?issnTenantId={issnTenantId}&tenantCellNumber={tenantCellNumber}&openPortalUserName={openPortalUserName}

Sends the custom message SMS.

POST v1/xpresscollect/{facilityId}/paymentreceipt/{tenantPmsId}/email

Sends the xpress collect payment receipt email.

POST v1/xpresscollect/{facilityId}/paymentreceipt/{tenantPmsId}/sms

Sends the xpress collect payment receipt SMS.

POST v1/xpresscollect/{facilityId}/promisetopayreceipt/{tenantPmsId}/email

Sends the xpress collect promise to pay receipt email.

POST v1/xpresscollect/{facilityId}/promisetopayreceipt/{tenantPmsId}/sms

Sends the xpress collect promise to pay receipt SMS.

POST v1/xpresscollect/logactivity

Logs the activity data.

GET v1/xpresscollect/{facilityId}/manualcalls

Gets the xpress collect manual calls by facility identifier.

GET v1/xpresscollect/manualcall/{Id}

Gets the xpress collect manual call by identifier.

PUT v1/xpresscollect/{facilityId}/manualcalls

Updates the xpress collect manual call.

POST v1/xpresscollect/{facilityId}/manualcalls

Inserts the xpress collect manual call.

GET v1/xpresscollect/{facilityId}/tenant/{tenantPmsId}/unit/{unitId}

Gets the xpress collect tenant.

POST v1/xpresscollect/{facilityId}/tenant/{pmsTenantId}/promisetopay

Inserts the xpress collect promise to pay.

GET v1/xpresscollect/{facilityId}/tenant/{pmsTenantId}/promisetopay/{unitName}

Determines whether [has xpress collect promise to pay] [the specified facility identifier].

OnlineHelp

Online Help Controller

APIDescription
GET v1/onlinehelp?mainProduct={mainProduct}&subProduct={subProduct}

Gets the online help topics.

Kiosk

INSOMNIAC Kiosk Controller

APIDescription
GET v1/kiosks?searchTerm={searchTerm}

Gets the kiosks.

GET v1/kiosk?cisId={cisId}

Gets the kiosk information.

GET v1/kiosk?did={did}

Gets the kiosk information.

GET v1/kiosk/ValidateIcuLicense?accountId={accountId}&cisId={cisId}

Validates the icu license.

GET v1/kiosk/ValidateIcuLicense?licenseKey={licenseKey}&cisId={cisId}

Validates the icu license new.

POST v2/kiosk/{cisId}/reportCash

No documentation available.

POST v1/kiosk/reportEscrowCash

No documentation available.

POST v1/kiosk/{cisId}/reporttransaction

No documentation available.

POST v1/kiosk/{cisId}/removeBills

No documentation available.

GET v1/kiosk/rentalOptions?cisId={cisId}

No documentation available.

GET v1/kiosk/{cisId}/settings

No documentation available.

GET v1/kiosk/{cisId}/approvalbullets

No documentation available.

GET v1/kiosk/{cisId}/livehelp

No documentation available.

GET v1/kiosk/{cisId}/tenantrestrictions

No documentation available.

GET v1/kiosk/{cisId}/cash?returnRemovedBills={returnRemovedBills}

No documentation available.

GET v1/kiosk/{cisId}/leasequestions

No documentation available.

POST v1/kiosk/{cisId}/savefile/{folder}

No documentation available.

POST v1/kiosk/{cisId}/heartbeat

No documentation available.

ContactValidation

Contact Validation Controller

APIDescription
POST v1/ContactValidation/PhoneNumbers

Validates the phone numbers.

POST v1/ContactValidation/EmailAddresses

Validates the email addresses.

GET v1/ContactValidation/VerifyAllUnverifiedPoints

Vefifies all unverified points.

TextMessage

Text Message Controller

APIDescription
GET v1/SMS/SendTextMessage?sendTo={sendTo}&body={body}

Sends a text message.

GET v1/SMS/SendTextMessage/{twilioAccountName}?sendTo={sendTo}&body={body}

Sends a text message.

GET v1/SMS/GetMessage?messageId={messageId}

Gets the message from message identifier.

GET v1/SMS/GetMessage/{twilioAccountName}?messageId={messageId}

Gets the message from message identifier.

GET v1/SMS/CheckMessageStatus?messageId={messageId}

Checks the message status.

GET v1/SMS/CheckMessageStatus/{twilioAccountName}?messageId={messageId}

Checks the message status.

GET v1/SMS/GetAccountPhoneNumber?twilioAccountName={twilioAccountName}

Gets the name of the twilio phone numbers by twilio account.

GET v1/SMS/GetTwilioSubAccount?twilioAccountName={twilioAccountName}

Gets the name of the twilio sub account from twilio account.

POST v1/SMS/CreateSubAccount?accountName={accountName}

Creates the sub account.

POST v1/SMS/PurchasePhoneNumber?accountName={accountName}&areaCode={areaCode}

Purchases the phone number for account.

POST v1/SMS/UpdatePhoneNumberOptions

Updates the phone number options.

POST v1/SMS/RemovePhoneNumber?accountName={accountName}

Removes the phone number for account.

IDVerification

ID Verification Controller

APIDescription
GET v1/IDVerification/idverify?FacilityId={FacilityId}&CISID={CISID}&FirstName={FirstName}&LastName={LastName}&DriverLicenseState={DriverLicenseState}&DriverLicenseNumber={DriverLicenseNumber}&Phone={Phone}&Street={Street}&City={City}&StateAbbrv={StateAbbrv}&PostalCode={PostalCode}&SocialSecurityNumber={SocialSecurityNumber}&DateOfBirth={DateOfBirth}

Verifies the specified user's identity.