Resident API

AccountBalance

API	Description
GET residentapi/units/{unitId}/accountbalance?transactions={transactions}&sort={sort}&startDate={startDate}	Returns the account balance and optionally the transactions for a unit
GET residentapi/units/{unitId}/clickpay/verify?email={email}	Verifies clickpay request

AlertMessages

API	Description
POST residentapi/alertmessages	Create an alert message
GET residentapi/units/{unitId}/alertmessages	Return messages for a unit
PUT residentapi/alertmessages	Updates the "ReadOn" flag to true for the provided alert messages

Amenity

API	Description
GET residentapi/amenities/{id}	Gets Amenities by ID
GET residentapi/properties/{propertyId}/amenities	Gets Amenities by Property and Type
GET residentapi/resourceuid/{resourceUid}/amenities	Gets Amenities by resourceUid

AmenityAvailability

API	Description
GET residentapi/properties/{propertyId}/amenityavailability?startDate={startDate}&endDate={endDate}	Gets Amenities by Property and Type
GET residentapi/amenity/{amenityId}/amenityavailability?startDate={startDate}&endDate={endDate}	Gets Amenities by Property and Type

ArchModAttachments

API	Description
GET residentapi/archmodattachments/{id}	Gets Arch Mod attachment by ID
GET residentapi/archmods/{archModId}/archmodattachments?page={page}&pageSize={pageSize}	Get all Arch Mod Attachments by ArchMod MyUnitId
POST residentapi/archmods/{archModId}/archmodattachments	Create an archmod attachment
DELETE residentapi/archmodattachments/{id}	Remove an archmod attachment

ArchModCategories

API	Description
GET residentapi/archmodcategories	Get all of the possible arch mod categories that an arch mod can be linked to

ArchMods

API	Description
GET residentapi/archmods/{id}	Get the arch mod by id
GET residentapi/archmods/connectproperty/{connectPropertyId}/smartwebslink?connectResidentId={connectResidentId}	Get smartwebs arch mods url
PUT residentapi/archmods/{id}	Updates an archmod
POST residentapi/archmods	Creates an archmod
DELETE residentapi/archmods/{id}	Deletes an arch mod
GET residentapi/units/{unitId}/archmods?page={page}&pageSize={pageSize}&sort={sort}&status={status}	Gets all the arch mods for a unit
GET residentapi/properties/{propertyId}/archmods?page={page}&pageSize={pageSize}&sort={sort}&occupantName={occupantName}&unitNumber={unitNumber}&description={description}&status={status}&progressCode={progressCode}&category={category}&datesubmitted={datesubmitted}&startDate={startDate}&endDate={endDate}	Gets all the arch mods for a property

CamAcctBankBalance

API	Description
GET residentapi/properties/{propertyId}/camacctbankbalance	Returns the bank balances from CamAcct for a specific property.

CollectionItems

API	Description
GET residentapi/collections/{collection}/collectionitems	Get all collection items in a collection.

CommonAreas

API	Description
GET residentapi/properties/{propertyId}/commonareas	Get all common areas for a property

CompanyConfig

API	Description
GET residentapi/companyconfig/{key}?propertyId={propertyId}	Get the company config by key

Countries

API	Description
GET residentapi/countries/{id}	Gets CountryCode action by ID
GET residentapi/countries	Get all countries

CwsCommittee

API	Description
DELETE residentapi/committees/{committeeId}/users	Removes user from a committee
DELETE residentapi/board/users	Removes a user from a board committee
POST residentapi/committees/{committeeId}/users	Adds an occupant to a committee
POST residentapi/committees	Create a committee
POST residentapi/board/users	Add a user to a board committee
PUT residentapi/committees/{id}	Updates a Property Committee
PUT residentapi/board/users/{id}	Updates a user who is a part of the board committee
GET residentapi/properties/{propertyId}/directory/committees/users?page={page}&pageSize={pageSize}&committeeIds[0]={committeeIds[0]}&committeeIds[1]={committeeIds[1]}	Gets users for a property who have opted in to be shown in the properties' directory
GET residentapi/properties/{propertyId}/directory/committees/summary	Gets committees and member count of user registered on directory by propertyId (committees with no members will be excluded)
DELETE residentapi/committees/{id}	Soft deletes a committee
POST residentapi/cwsmarkets/{marketId}/users/{userId}/committees/sync	Adds user to any committees or board committees that he/she belongs to in connect

CwsProperties

API	Description
POST residentapi/cwsproperties	Create a CWS property
PUT residentapi/cwsproperties/{id}	Updates Cws property

CwsPropertyConfiguration

API	Description
GET residentapi/market/{c4uid}/connectproperty/{propertyId}/connectresidenturl	No documentation available.

CwsPropertyProfile

API	Description
GET residentapi/properties/{propertyId}/cwsprofile	Gets the CWS profile data for a given property.

CwsUser

API	Description
PUT residentapi/users/{id}/termsandconditions	The user has accepted terms and conditions
GET residentapi/users/{identservId}	Get cws user information by Identity Server Id
GET residentapi/users/{propertyId}	Get cws user information by propertyId

CwsValetQueue

API	Description
POST residentapi/valet	Make a valet request
DELETE residentapi/valet/{id}	Delete CwsValetQueue action
GET residentapi/units/{unitId}/valet?page={page}&pageSize={pageSize}&sort={sort}	Get Valet by unitId

Documents

API	Description
GET residentapi/propertydocuments/{id}	Gets CommunityDocument by ID
GET residentapi/properties/{propertyId}/propertydocuments?page={page}&pageSize={pageSize}&sort={sort}&search={search}&showFeaturedDocumentsFirst={showFeaturedDocumentsFirst}&includePrivateDocuments={includePrivateDocuments}&documentTypeIds[0]={documentTypeIds[0]}&documentTypeIds[1]={documentTypeIds[1]}&documentSubTypeIds[0]={documentSubTypeIds[0]}&documentSubTypeIds[1]={documentSubTypeIds[1]}	Get the community documents by propertyid

DocumentSubtypes

API	Description
GET residentapi/properties/{propertyId}/documentsubtypes?documentTypeId={documentTypeId}&includePrivateDocuments={includePrivateDocuments}	Get document subtypes by documentTypeId that have at least one document associated with it in alphabetical order

DocumentTypes

API	Description
GET residentapi/documenttypes/{id}	Gets a Document Type by ID
GET residentapi/documenttypes	Get all Document Types in alphabetical order

EmergencyContact

API	Description
GET residentapi/units/{unitId}/emergencycontact	Get all of the emergency contacts for a unit
POST residentapi/emergencycontact	Create an emergency contact record
PUT residentapi/emergencycontact/{id}	Update an emergency contact
DELETE residentapi/emergencycontact/{id}	Delete an emergency contact

EventCategories

API	Description
GET residentapi/eventcategories	Get all of the possible event categories

Events

API	Description
GET residentapi/myunits/{myUnitId}/eventcalendars	Gets all of the calendars from connect (that the myunit role has access to view) and a single calendar for CWS
GET residentapi/myunits/{myUnitId}/events?startDate={startDate}&endDate={endDate}&includeCancelledEvents={includeCancelledEvents}&calendarIds[0]={calendarIds[0]}&calendarIds[1]={calendarIds[1]}	Returns a combination list of events from both cws and connect. If both start and end dates are not provided, the return set will be the between the first and last day of the current month
PUT residentapi/events/{id}	Updates an event
POST residentapi/events	Create an event
DELETE residentapi/events/{id}	Remove an event from the calendar
POST residentapi/myunits/{myUnitId}/events/{eventId}/eventphotos	Save an event photo

EventSubCategories

API	Description
GET residentapi/eventcategories/{categoryID}/eventsubcategories	Get all of the sub categories for a categoryID

ExternalLinks

API	Description
GET residentapi/externallinks/{linkName}	Returns the external link object by the unique link name

Files

API	Description
GET residentapi/files?filePath={filePath}	Returns a file given the encoded file path. This route can not be called unless the prerequisite route that contains the file path is called first. The prerequisite route will contain an encoded file path named FileUrl. This FileUrl value should be passed as the filePath query string value when calling this route.
GET residentapi/files/url?entityId={entityId}&folderName={folderName}&filePath={filePath}	Returns file url where user can view the file
GET residentapi/publicfileurl?dfsFilePath={dfsFilePath}	Get the public file url from the dfs filepath

GlobalDirectory

API	Description
GET residentapi/properties/{propertyId}/global/directory/users?sort={sort}&page={page}&pageSize={pageSize}&userTypes[0]={userTypes[0]}&userTypes[1]={userTypes[1]}&committeeIds[0]={committeeIds[0]}&committeeIds[1]={committeeIds[1]}&boardmembers={boardmembers}	Get global users by property
GET residentapi/properties/{propertyId}/global/directory/summary	Gets the number of user's for each of the following types: 'owner', 'renter', 'resident' for a property
GET residentapi/properties/{propertyId}/global/directory/committees/summary	Gets committees and member count of user registered on directory by propertyId (committees with no members will be excluded)

InfoCenterAnswers

API	Description
GET residentapi/infocenteranswers?propertyId={propertyId}&includeprivatequestions={includeprivatequestions}&includenonapplicable={includenonapplicable}&includeunanswered={includeunanswered}&includeattachments={includeattachments}	Gets all of the call center answers for a property
GET residentapi/properties/{propertyId}/infocenteranswers?includeprivatequestions={includeprivatequestions}&includenonapplicable={includenonapplicable}&includeunanswered={includeunanswered}&includeattachments={includeattachments}	Gets all of the call center answers for a property

InfoCenterCategories

API	Description
GET residentapi/properties/{propertyId}/infocentercategories	Get all InfoCenter Categories by property id

InfoCenterDocuments

API	Description
GET residentapi/infocenterdocuments/{id}	Gets InfoCenterDocument action by ID
GET residentapi/properties/{propertyId}/infocenterdocuments?page={page}&pageSize={pageSize}	Get all InfoCenterDocument by propertyId

InfoCenterQuestions

API	Description
GET residentapi/properties/{propertyId}/infocenterquestions?categoryIds[0]={categoryIds[0]}&categoryIds[1]={categoryIds[1]}&searchText={searchText}&isFaq={isFaq}&page={page}&pageSize={pageSize}	Get all InfoCenter Questions by property id

API	Description
GET residentapi/units/{unitId}/menu	Get's the menu items (hamburger menu in upper left) and all associated tabs of the menu items that the user has access to based on permssions

MyUnits

API	Description
POST residentapi/myunits	Accepts a list of MyUnit object to update or insert new linked units.
GET residentapi/market/{c4uid}/connectresidents/{connectResidentId}	Returns CWS Unit object if connect resident is actively registered with the CWS.
DELETE residentapi/myunits/{id}	Soft deletes cws unit
DELETE residentapi/market/{c4uid}/connectunits/{connectUnitId}	Soft deletes all cws units for a particular connect unit
DELETE residentapi/market/{c4uid}/connectresidents/{connectResidentId}	This will soft delete the CWS unit linked to this occupant and market. Also, it will delete the occupant from any board or committee they are apart of.
DELETE residentapi/market/{c4uid}/connectproperty/{connectPropertyId}/units	Soft deletes all cws units for a particular connect property

Occupants

API	Description
GET residentapi/occupants/{id}	Get Occupant by ID
PUT residentapi/occupants/{id}	Update Occupant
GET residentapi/units/{unitId}/occupants?sort={sort}&page={page}&pageSize={pageSize}	Get Occupants by Unit Id
GET residentapi/properties/{propertyId}/occupants?sort={sort}&page={page}&pageSize={pageSize}	Get Occupants by property

Packages

API	Description
GET residentapi/units/{unitId}/pendingpackages?sort={sort}&page={page}&pageSize={pageSize}	Gets pending packages for a unit

Pets

API	Description
GET residentapi/units/{unitId}/pets	Get all pets for a unit
GET residentapi/properties/{propertyId}/pets?sort={sort}&page={page}&pageSize={pageSize}&occupantName={occupantName}&petName={petName}&unit={unit}&description={description}&vaccinationDate={vaccinationDate}	Get all pets for a property
POST residentapi/pets	Create a pet record for a unit
PUT residentapi/pets/{id}	Update a pet
DELETE residentapi/pets/{id}	Remove a pet from a unit

ProgressCodes

API	Description
GET residentapi/progresscodes/{id}	Gets TrackinglogProgress action by ID
GET residentapi/progresscodes	Get all TrackinglogProgress
GET residentapi/progresscodes/workorders	Get all WorkOrder Progress Codes
GET residentapi/progresscodes/archmods	Get all WorkOrder Progress Codes

Properties

API	Description
GET residentapi/properties/{id}/contactinformation	Gets the property with all associated information including Name, Address, Type, ManagementOffice, Association Manager, etc.
POST residentapi/properties/contactmessage	Send a message to contact the help desk
GET residentapi/myunits/{myUnitId}/quickactions	Gets quick actions by unit.

States

API	Description
GET residentapi/states/{id}	Gets State action by ID
GET residentapi/states?countryCode={countryCode}&onlyMilitary={onlyMilitary}	Get all States

TermsAndConditions

API	Description
GET residentapi/termsandconditions/{resourceUid}	Gets Amenities Terms and Conditions by resourceUid

Test

API	Description
GET residentapi/testing/{function}	Gets the property with all associated information including Name, Address, Type, ManagementOffice, Association Manager, etc.

UnitAlternateAddresses

API	Description
PUT residentapi/alternateaddresses/{id}	Updates Alternate Address
PUT residentapi/alternateaddresses/{addressId}/billing	Sets Official Billing Address
POST residentapi/alternateaddresses	Inserts new Alternate Address
GET residentapi/units/{unitId}/alternateaddresses	Get alternate addresses for a unit

Units

API	Description
GET residentapi/units/carecenterunits?email={email}&mobile={mobile}	Returns all units linked to a particular email address or phone number.

UserDirectory

API	Description
GET residentapi/directory/{id}	Gets UserDirectory by id
GET residentapi/properties/{propertyId}/directory/users?page={page}&pageSize={pageSize}&sort={sort}&userTypes[0]={userTypes[0]}&userTypes[1]={userTypes[1]}&committeeIds[0]={committeeIds[0]}&committeeIds[1]={committeeIds[1]}	Gets users for a property who have opted in to be shown in the properties' directory
GET residentapi/directory/{unitId}	Gets directory by unitid
GET residentapi/properties/{propertyId}/directory/summary	Gets the number of user's for each of the following types: 'owner', 'renter', 'resident' for a property
POST residentapi/directory	Insert directory
PUT residentapi/directory/{id}	Updates a user directory
DELETE residentapi/directory/{id}	Delete a user directory

UserPhotos

API	Description
POST residentapi/myunits/{myUnitId}/userphotos	Saves a profile photo to the database
GET residentapi/users/{userId}/profilephoto	Retrieves the url for the provided photoId

VehicleMakes

API	Description
GET residentapi/vehiclemakes	Get all Vehicle Makes

Vehicles

API	Description
GET residentapi/units/{unitId}/vehicles?page={page}&pageSize={pageSize}	Get all UnitsVehicle
GET residentapi/properties/{propertyId}/vehicles?page={page}&pageSize={pageSize}&sort={sort}&unit={unit}&VehicleType={VehicleType}&vehicleYear={vehicleYear}&vehicleMake={vehicleMake}&vehicleModel={vehicleModel}&vehiclePlatenumber={vehiclePlatenumber}&vehicleSpacenumber={vehicleSpacenumber}&vehicleDecalnumber={vehicleDecalnumber}	Get all vehicles for a property
POST residentapi/vehicles	Create a vehicle record for a unit
PUT residentapi/vehicles/{id}	Update a vehicle
DELETE residentapi/vehicles/{id}	Remove vehicle from a unit

VehicleTypes

API	Description
GET residentapi/vehicletypes?page={page}&pageSize={pageSize}	Get all vehicle types

ViolationActions

API	Description
GET residentapi/properties/{propertyId}/violationactions	Get violation actions by property

ViolationLetters

API	Description
GET residentapi/violations/{violationId}/violationletters?page={page}&pageSize={pageSize}

Violations

API	Description
GET residentapi/units/{unitId}/violations?page={page}&pageSize={pageSize}&sort={sort}	Get all open violations including any violation letters for a unit id
GET residentapi/properties/{propertyId}/violations?unitnumber={unitnumber}&action={action}&status={status}&description={description}&createddate={createddate}&hearingdate={hearingdate}&inspectiondate={inspectiondate}&sort={sort}&page={page}&pageSize={pageSize}	Get all violations for a property.

VisitorAccessHours

API	Description
GET residentapi/visitoraccesshours	Get all visitor access hours

Visitors

API	Description
GET residentapi/visitors/{id}	Get visitor by id
PUT residentapi/visitors/{id}	Update a visitor
POST residentapi/visitors	Insert a new visitor
DELETE residentapi/visitors/{id}	Delete a visitor
GET residentapi/units/{unitId}/visitors?type={type}&status={status}&sort={sort}&page={page}&pageSize={pageSize}	Get visitors by unit

VisitorTypes

API	Description
GET residentapi/visitortypes	Get all visitor types (None, OneTime, Temporary, Overnight, LongTerm, Permanent)

WorkorderCategories

API	Description
GET residentapi/workordercategories	Get all Workorder Categories

WorkorderPhotos

API	Description
POST residentapi/workorders/{workorderId}/workorderphotos	Insert work order photo
DELETE residentapi/workorderphotos/{id}	Remove a work order photo
GET residentapi/workorders/{workorderId}/workorderphotos?page={page}&pageSize={pageSize}	Get work order photos by the work order Id

Workorders

API	Description
GET residentapi/units/{unitId}/workorders?status={status}&sort={sort}&page={page}&pageSize={pageSize}	Gets the work orders for a unit
GET residentapi/properties/{propertyId}/workorders?status={status}&type={type}&category={category}&number={number}&progress={progress}&submittedby={submittedby}&sort={sort}&page={page}&pageSize={pageSize}	Gets the work orders for a property
POST residentapi/workorders	Creates a work order
DELETE residentapi/workorders/{id}	Soft Deletes a WorkOrder
PUT residentapi/workorders/{id}	Update Workorder