# Retrieve unit locations

Fetches a paginated list of unit locations within the Property Management System (PMS). This endpoint allows filtering by unit ID, building ID to retrieve specific unit locations and also, unit location last updated date time. Unit locations represent different areas or spaces within a unit (e.g., bathrooms, living spaces). The response includes location details such as type, description, and associated metadata. If no locations are found for the specified filters, an empty page will be returned. Results are paginated to handle large datasets efficiently.

Endpoint: GET /api/v3/unitLocations
Version: 3.0.4
Security: OAuth2

## Query parameters:

  - `unitId` (integer)
    ID of the unit to filter locations

  - `buildingId` (integer)
    ID of the building to filter locations

  - `lastUpdatedAfter` (string)
    Last Updated Date - filter locations last updated after this value

## Response 200 fields (application/json):

  - `content` (array)

  - `content.id` (integer)
    Unique identifier for the unit internal location
    Example: 1

  - `content.unit` (object)
    Summary of the Unit associated with the Unit Access Group

  - `content.unit.id` (integer)
    Unique identifier of the unit
    Example: 1

  - `content.unit.name` (string)
    Name of the unit
    Example: "Apartment 101"

  - `content.internalLocation` (object)
    Data Transfer Object (DTO) for representing an InternalLocation entity. This class provides a simplified representation of InternalLocation for use in data exchange operations, such as API communication, while masking unnecessary internal details.

  - `content.internalLocation.id` (integer)
    Unique identifier for the internal location
    Example: 1

  - `content.internalLocation.name` (string)
    Name of the internal location
    Example: "Master Bedroom"

  - `content.internalLocation.type` (string)
    Type of the internal location. Can be one of: BEDROOM, BATHROOM, LIVING_ROOM, KITCHEN, DINING_ROOM, HALL, GENERAL, WC, BEDROOM_OR_LIVING_ROOM_WITH_KITCHEN_CORNER, KITCHEN_IN_THE_LIVING_OR_DINING_ROOM
    Enum: "BEDROOM", "BATHROOM", "LIVING_ROOM", "KITCHEN", "DINING_ROOM", "HALL", "GENERAL", "WC", "BEDROOM_OR_LIVING_ROOM_WITH_KITCHEN_CORNER", "KITCHEN_IN_THE_LIVING_OR_DINING_ROOM"

  - `content.internalLocation.systemType` (boolean)
    Flag indicating whether this is a system-defined location type

  - `content.internalLocation.primaryLocation` (boolean)
    Flag indicating whether this is designated as the primary location
    Example: true

  - `content.internalLocation.category` (string)
    Category of the internal location. Can be either INTERNAL or EXTERNAL
    Enum: "INTERNAL", "EXTERNAL"

  - `content.imagesAttachments` (array)
    List of image attachments associated with this internal location

  - `content.imagesAttachments.relationType` (string)
    Type of relation for the image attachment
    Example: "INTERIOR"

  - `content.imagesAttachments.isPrimary` (boolean)
    Indicates if this image is the primary one
    Example: true

  - `content.imagesAttachments.sortOrder` (integer)
    Sort order for displaying images
    Example: 1

  - `content.imagesAttachments.internalName` (string)
    Internal name for the image
    Example: "kitchen_view"

  - `content.imagesAttachments.viewUrl` (string)
    URL to view the image
    Example: "https://example.com/image.jpg"

  - `content.featureFacilities` (array)
    List of features and facilities available in this internal location

  - `content.featureFacilities.id` (integer)
    Unique identifier for the feature/facility
    Example: 1

  - `content.featureFacilities.category` (string)
    Category of the feature/facility
    Example: "Amenity"

  - `content.featureFacilities.iconClass` (string)
    CSS class name for the feature/facility icon
    Example: "icon-wifi"

  - `content.featureFacilities.name` (string)
    Name of the feature/facility in primary language
    Example: "Wi-Fi"

  - `content.featureFacilities.nameLang2` (string)
    Name of the feature/facility in secondary language
    Example: "Wi-Fi"

  - `content.featureFacilities.nameLang3` (string)
    Name of the feature/facility in tertiary language
    Example: "WLAN"

  - `content.featureFacilities.nameLang4` (string)
    Name of the feature/facility in quaternary language
    Example: "Wi-Fi"

  - `content.featureFacilities.nameLang5` (string)
    Name of the feature/facility in quinary language
    Example: "Wi-Fi"

  - `content.sortOrder` (integer)
    Sort order for displaying this internal location in lists
    Example: 1

  - `content.primaryImageUrl` (string)
    URL of the primary image for this internal location
    Example: "https://example.com/images/location1.jpg"

  - `page` (object)

  - `page.size` (integer)

  - `page.totalElements` (integer)

  - `page.totalPages` (integer)

  - `page.number` (integer)