Get started

Learn how to start the Real Estate Real Data API, and create users and properties. These instructions are for Windows.

System requirements

GitHub Desktop
The Postman app. The Real Estate Real Data API service runs on your development system with an http://localhost hostname. Therefore, the service doesn’t work with the web-version of Postman.
The current LTS version of node.js
The current version of json-server
A fork of this repo. Ensure it includes the database file.

Start the service

Open the fork in Command Prompt. In GitHub Desktop, switch to the fork. Go to Repositories > Open in Command Prompt.
In Command Prompt, change directory to API.
```
 cd api
```

In the API directory, open the database file.

 json-server -w property-manager.json

The json server starts on a local port. Note the index. This is your base URL.

Example response

 Index:
 http://localhost:3000/

 Endpoints:
 http://localhost:3000/properties
 http://localhost:3000/users

The service is now started.

Create users

Create an owner or manager user and assign them read-only or CRUD permissions.

Open the Postman app and create a POST request.
```
 {base_url}/users/
```
In the Headers section, ensure content-type is application/json.
In the Body section, select raw.
In the Body text field, enter the properties and values for the manager user. See Users.

Note: All properties are required.
Click Send. The manager user is created, and it appears in the Response Body section.
Repeat the above steps to create an owner user.

Example

Request

http://localhost:3000/users

{
    "id": "4",
    "username": "patrick.johnson",
    "role": "manager",
    "permissions": "crud"
}

Response

{
    "id": "4",
    "username": "patrick.johnson",
    "role": "manager",
    "permissions": "crud"
}

Create properties

Add a property to your portfolio.

In the Postman app, create a POST request.
```
 {base_url}/properties/
```
In the Headers section, ensure content-type is application/json.
In the Body section, select raw.
In the Body text field, enter the property details. See Properties.
Click Send. A property is created and it appears in the Response Body section.
Repeat the above steps to create more properties.

Example

Request

http://localhost:3000/properties

{
    "building_name": "Ocean View Condos",
    "address_line_1": "789 Ocean View Dr",
    "address_line_2": "Suite 305",
    "address_line_3": "Atlanta, GA 35034",
    "id": 9,
    "owner_id": 7,
    "manager_id": 8
}

Response

{
    "building_name": "Ocean View Condos",
    "address_line_1": "789 Ocean View Dr",
    "address_line_2": "Suite 305",
    "address_line_3": "Atlanta, GA 35034",
    "id": 9,
    "owner_id": 7,
    "manager_id": 8
}

Get started

System requirements

Start the service

Create users

Example

Request

Response

Create properties

Example

Request

Response

Next steps