Skip to main content

​
Resident Guide

This guide covers all features available to residents of Happy Habitat communities. As a resident, you can manage your profile, book amenities, submit support tickets, view documents, and stay informed about community events.

​
Getting Started

​
Your Account

Residents are assigned to a specific community and have their own user account linked to their residence. Test Resident Accounts: 
Username: resident1
Password: password123

Username: resident2
Password: password123
Your administrator will provide your login credentials. Contact your community office if you need assistance.

​
First Login

  1. Navigate to the login page
  2. Enter your username and password
  3. You’ll be redirected to your resident dashboard
  4. Update your profile information

​
Your Profile

​
View Your Information

Endpoint: GET /api/users/me/resident Retrieve your resident ID and basic information.

​
Update Contact Information

Contact your administrator to update:
  • Phone number
  • Email address
  • Emergency contact
  • Unit/apartment number

​
Managing Vehicles

Register your vehicles for parking and access control.

​
View Your Vehicles

Endpoint: GET /api/vehicles See all vehicles registered to your residence.

​
Register a Vehicle

Endpoint: POST /api/vehicles Request Body: 
{
  "residentId": "your-resident-guid",
  "vehicleTypeId": "77777777-7777-7777-7777-777777777777",
  "brand": "Toyota",
  "model": "Camry",
  "year": 2020,
  "color": "Silver",
  "licensePlate": "ABC-123"
}
Vehicle Types: 
Car:        77777777-7777-7777-7777-777777777777
Motorcycle: 88888888-8888-8888-8888-888888888888
Truck:      99999999-9999-9999-9999-999999999999
SUV:        AAAAAAAA-BBBB-BBBB-BBBB-BBBBBBBBBBBB
Van:        BBBBBBBB-CCCC-CCCC-CCCC-CCCCCCCCCCCC

​
Update Vehicle Information

Endpoint: PUT /api/vehicles/{id} Update vehicle details like color, plate number, or model.

​
Remove a Vehicle

Endpoint: DELETE /api/vehicles/{id} Remove a vehicle from your registered list.

​
Managing Pets

Register your pets for community records and access to pet-friendly areas.

​
View Your Pets

Endpoint: GET /api/pets

​
Register a Pet

Endpoint: POST /api/pets Request Body: 
{
  "residentId": "your-resident-guid",
  "name": "Max",
  "species": "Dog",
  "breed": "Golden Retriever",
  "age": 3,
  "color": "Golden",
  "weight": 30.5,
  "vaccinationRecord": "Up to date"
}

​
Update Pet Information

Endpoint: PUT /api/pets/{id} Update pet details including vaccination records and age.

​
Remove a Pet

Endpoint: DELETE /api/pets/{id}

​
Managing Visits

Register visitors for security and access control.

​
View Your Visits

Endpoint: GET /api/residentvisits

​
Register a Visitor

Endpoint: POST /api/residentvisits Request Body: 
{
  "residentId": "your-resident-guid",
  "visitorName": "John Doe",
  "totalPeople": 2,
  "vehicleColor": "Red",
  "licensePlate": "VIS-001",
  "subject": "Family Visit",
  "arrivalDate": "2025-03-10T14:00:00Z",
  "departureDate": "2025-03-10T18:00:00Z"
}
Register visitors in advance to expedite security check-in at the gate.

​
Update Visit Information

Endpoint: PUT /api/residentvisits/{id} Update visit dates, vehicle information, or number of people.

​
Cancel a Visit

Endpoint: DELETE /api/residentvisits/{id}

​
Support Tickets

Submit maintenance requests, report issues, or ask questions.

​
View Your Tickets

Endpoint: GET /api/tickets/my See all tickets you’ve submitted and their current status.

​
Submit a New Ticket

Endpoint: POST /api/tickets Request Body: 
{
  "title": "Pool filter not working",
  "description": "The pool filter has been making unusual noises and water clarity is poor.",
  "categoryId": 2,
  "priority": "MEDIUM"
}
Ticket Categories:
  1. Areas comunes - Common areas issues
  2. Amenidades - Amenity problems
  3. Mantenimiento - Maintenance requests
  4. Mascotas - Pet-related issues
  5. Pregunta / comentario - Questions or comments
  6. Ruido - Noise complaints
  7. Servicios - Utilities (electricity, water, gas, internet)
  8. Sugerencia - Suggestions
  9. Vigilancia - Security issues
  10. Otro - Other
Priority Levels:
  • LOW - Non-urgent issues
  • MEDIUM - Normal priority
  • HIGH - Urgent issues requiring quick attention
  • CRITICAL - Emergency situations

​
Check Ticket Status

Ticket Statuses:
1

Nuevo

Your ticket has been created and is in the queue
2

En revisión

The team is reviewing your ticket
3

En investigación

The issue is being investigated
4

En proceso

Work is being done to resolve your issue
5

Resuelto

Your issue has been resolved

​
Update Your Ticket

Endpoint: PUT /api/tickets/{id}
You can only update tickets you created. Add additional details or update the description as needed.

​
Viewing Documents

Access important community documents like rules, regulations, and announcements.

​
View Community Documents

Endpoint: GET /api/documents/community/{communityId} Browse documents available for your community.

​
Download a Document

Endpoint: GET /api/documents/{id}/download
You can only download documents for your community or documents you uploaded.

​
Community Announcements

Stay informed about community events, maintenance schedules, and important notices.

​
View Announcements

Endpoint: GET /api/comunicados/community/{communityId} See all announcements for your community.

​
Announcement Types

Comunicados may include:
  • Maintenance schedules
  • Community events
  • Rule changes
  • Emergency notifications
  • Holiday celebrations
  • Amenity closures

​
Viewing Banners

See seasonal and event banners on your dashboard. Endpoint: GET /api/banners/community/{communityId} Banner Events:
  • New Year celebrations
  • Independence Day (September 16)
  • Halloween
  • Day of the Dead (Día de Muertos)
  • Christmas and holiday season
  • Mother’s Day and Father’s Day
  • Community-specific events

​
Payments and Charges

​
View Your Charges

Endpoint: GET /api/cargosresidente See maintenance fees and other charges.

​
View Payment History

Endpoint: GET /api/pagosresidente Track your payment history and outstanding balances.

​
Make a Payment

Contact your administrator for payment methods:
  • Online banking transfer
  • Cash at community office
  • Credit/debit card (if available)
  • Check
Keep records of all payments for your personal records.

​
Surveys and Feedback

​
Participate in Surveys

Endpoint: GET /api/encuestas View and participate in community surveys and polls. Survey Topics:
  • Amenity improvements
  • Community satisfaction
  • Event planning
  • Rule changes
  • Budget allocation

​
Amenity Booking

Amenity booking features are managed by administrators. Contact your community office to reserve amenities.

​
Available Amenities

Common amenities may include:
  • Swimming pool
  • Gym/fitness center
  • Event hall
  • BBQ areas
  • Sports courts
  • Playground
  • Meeting rooms

​
Booking Process

  1. Check amenity availability
  2. Contact administrator or use booking system
  3. Receive confirmation
  4. Follow amenity rules and time limits
  5. Clean up after use

​
Community Providers

View approved service providers for your community. Endpoint: GET /api/communityproviders Provider Types:
  • Maintenance services
  • Cleaning services
  • Landscaping
  • Security
  • Emergency services

​
Best Practices

Communication

  • Check announcements regularly for important updates
  • Submit tickets for any issues promptly
  • Respond to surveys to help improve the community
  • Keep your contact information up to date

Compliance

  • Follow community rules and regulations
  • Register all vehicles and pets
  • Pre-register visitors for smooth entry
  • Pay fees and charges on time
  • Respect quiet hours and common areas

Security

  • Keep your login credentials secure
  • Don’t share your account with others
  • Report suspicious activity immediately
  • Update your password periodically

​
Troubleshooting

​
Can’t Submit a Ticket

  1. Ensure you’re logged in
  2. Check that all required fields are filled
  3. Verify you have an active resident profile
  4. Contact administrator if the issue persists

​
Can’t Access Documents

  1. Verify the document belongs to your community
  2. Check your internet connection
  3. Try downloading in a different browser
  4. Contact administrator for access issues

​
Visit Registration Issues

  1. Ensure arrival date is in the future
  2. Provide complete visitor information
  3. Include vehicle details if visitor is driving
  4. Allow 24 hours for security processing

​
Need Help?

For assistance:
  • Contact your community administrator
  • Review the Authentication Guide for login help
  • Submit a ticket for technical issues
  • Call the community office during business hours
Community office hours and contact information can be found in your welcome packet or on community announcements.

Build docs developers (and LLMs) love

Get started for freeTalk to us