Properties

Detail about properties created in elyssa app

1. Get all proproperties

Listing of all properties with information pagination

GET /property/get_properties/{companyId}

List the properties that a company has registered in elyssa app; To improve performance, the information is paginated, the amount of data to be returned in each query is established

🤔 Each query returns a maximum of 20 properties

Params parameter

Name	Type	Description
companyId	uuid	internal company id on elyssa app

Query Parameters

Name	Type	Description
page*	number	first page: 1
sorter*	string	Options: 'desc' or 'asc'

200: OK Properties

{
    "data": [
        {
            "PropertyId": "002dd686-df79-4197-b1c6-31af14ba018",
            "Address": "carrera 62 no 76 95 ",
            "Neighborhood": "Concepción",
            "Code": "",
            "City": "barranquilla",
            "CreationDate": "2020-08-19T20:17:56.603Z",
            "IsActive": true,
            "Detail": null,
            "PropertyType": {
                "typeName": "Apartamento"
            }
        },
        {
            "PropertyId": "004edb2d-e129-4e86-be19-009971c807c",
            "Address": "prueba apptuno",
            "Neighborhood": "apptuno",
            "Code": "12345",
            "City": "Bogota prueba",
            "CreationDate": "2021-10-29T01:11:13.527Z",
            "IsActive": true,
            "Detail": null,
            "PropertyType": {
                "typeName": "Apartamento"
            }
        },
        {
            "PropertyId": "007235af-dff3-47b0-b684-3e690c00d936",
            "Address": "ignacio manuel altamirano 78",
            "Neighborhood": "San Rafael",
            "Code": "06470",
            "City": "ciudad de mexico",
            "CreationDate": "2023-02-03T23:58:12.963Z",
            "IsActive": true,
            "Detail": null,
            "PropertyType": {
                "typeName": "Apartamento"
            }
        },
        {
            "PropertyId": "00e2e10c-db41-4589-b11b-673fc172d979",
            "Address": "calle 79 no 67 -89",
            "Neighborhood": "recreo",
            "Code": "123",
            "City": "Barranquilla",
            "CreationDate": "2020-09-21T18:35:49.497Z",
            "IsActive": true,
            "Detail": null,
            "PropertyType": {
                "typeName": "Apartamento"
            }
        },
    ],
    "meta": {
        "total": 1053,
        "lastPage": 106,
        "currentPage": 1,
        "perPage": 20,
        "prev": null,
        "next": 2
    }
}

400: Bad Request

404: Not Found

2. Property detail

Detail of a property

GET /property/get_property_uuid/{propertyId}

All information about property with his inventories

Path Parameters

Name	Type	Description
propertyId*	uuid	Unique id of property

200: OK Detail property

{
    "PropertyId": "9280dd48-026a-4b33-b57a-e30dfe02ca81",
    "Address": "cra 100",
    "Neighborhood": "melendez",
    "Code": null,
    "City": "Cali, Valle del Cauca",
    "CreationDate": "2023-12-11T20:54:23.676Z",
    "Detail": null,
    "PropertyType": {
        "typeName": "Apartamento"
    },
    "Levels": 1,
    "IsRented": true,
    "Inventory": [
        {
            "InventoryId": "ab13452f-3961-4879-af7b-13141db2f68",
            "InventoryType": 2,
            "CreationDate": "2024-03-08T22:08:25.268Z",
            "IsSigned": false,
            "RentalPrice": "0",
            "SignatureDate": null,
            "Approval_Code": null,
            "PfdUrl": null
        },
        {
            "InventoryId": "ea84b117-3b51-44fc-b5dc-7bc283fb853",
            "InventoryType": 1,
            "CreationDate": "2023-12-13T04:07:43.756Z",
            "IsSigned": true,
            "RentalPrice": "592748",
            "SignatureDate": "2024-03-08T18:10:17.440Z",
            "Approval_Code": "",
            "PfdUrl": "a59d80fa-2261-40e3-b131-8209270e3f89.pdf"
        },
        {
            "InventoryId": "35e51408-478c-41a7-951a-e205a2a1763",
            "InventoryType": 0,
            "CreationDate": "2023-12-11T22:04:40.358Z",
            "IsSigned": true,
            "RentalPrice": "200000",
            "SignatureDate": "2023-12-12T22:35:53.300Z",
            "Approval_Code": "",
            "PfdUrl": "105bcb4b-73de-43de-8c97-e3c40f9cd99f.pdf"
        }
    ]
}

401: Unauthorized Permission denied

400: Bad Request Bad request

500: Internal Server Error Server error

Authentication

Authentication

Response

Read the documentation for the inventoryType attribute to understand the type of inventory present in the properties.

In the response for listing of all properties with information pagination, return the newOffset attribute, with this new value, can paginated the next properties. if the newOffset attribute is -1, is the last request can do to get data.