Address

Address - Get Address

HTTP Request

GET /api/addresses/{id}

📋 Description: Retrieves detailed information about a specific address associated with a portfolio or asset within the Nakisa Portfolio Management Suite, enabling enhanced analytics and management of real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

AddressDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "street": "string",
10  "civicNumber": "string",
11  "suite": "string",
12  "postalCode": "string",
13  "lon": 0.1,
14  "lat": 0.1,
15  "city": {
16    "createdBy": "string",
17    "lastModifiedBy": "string",
18    "createdDate": "2019-08-24T14:15:22Z",
19    "lastModifiedDate": "2019-08-24T14:15:22Z",
20    "archived": true,
21    "externalId": "string",
22    "id": 0,
23    "name": "string",
24    "province": {
25      "createdBy": "string",
26      "lastModifiedBy": "string",
27      "createdDate": "2019-08-24T14:15:22Z",
28      "lastModifiedDate": "2019-08-24T14:15:22Z",
29      "archived": true,
30      "externalId": "string",
31      "id": 0,
32      "name": "string",
33      "code": "string",
34      "country": {
35        "createdBy": "string",
36        "lastModifiedBy": "string",
37        "createdDate": "2019-08-24T14:15:22Z",
38        "lastModifiedDate": "2019-08-24T14:15:22Z",
39        "archived": true,
40        "externalId": "string",
41        "id": 0,
42        "name": "string",
43        "code": "string"
44      },
45      "provinceCountryKey": "string"
46    },
47    "cityProvinceCountryKey": "string"
48  },
49  "district": {
50    "createdBy": "string",
51    "lastModifiedBy": "string",
52    "createdDate": "2019-08-24T14:15:22Z",
53    "lastModifiedDate": "2019-08-24T14:15:22Z",
54    "archived": true,
55    "externalId": "string",
56    "id": 0,
57    "name": "string",
58    "city": {
59      "createdBy": "string",
60      "lastModifiedBy": "string",
61      "createdDate": "2019-08-24T14:15:22Z",
62      "lastModifiedDate": "2019-08-24T14:15:22Z",
63      "archived": true,
64      "externalId": "string",
65      "id": 0,
66      "name": "string",
67      "province": {
68        "createdBy": "string",
69        "lastModifiedBy": "string",
70        "createdDate": "2019-08-24T14:15:22Z",
71        "lastModifiedDate": "2019-08-24T14:15:22Z",
72        "archived": true,
73        "externalId": "string",
74        "id": 0,
75        "name": "string",
76        "code": "string",
77        "country": {
78          "createdBy": "string",
79          "lastModifiedBy": "string",
80          "createdDate": "2019-08-24T14:15:22Z",
81          "lastModifiedDate": "2019-08-24T14:15:22Z",
82          "archived": true,
83          "externalId": "string",
84          "id": 0,
85          "name": "string",
86          "code": "string"
87        },
88        "provinceCountryKey": "string"
89      },
90      "cityProvinceCountryKey": "string"
91    }
92  },
93  "cityId": 0,
94  "districtId": 0
95}

Address - Update Address

HTTP Request

PUT /api/addresses/{id}

📋 Description: Updates the details of a specified address within the Nakisa Portfolio Management Suite, ensuring accurate asset and portfolio information for enhanced analytics and real estate property management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

AddressDto

true

Request body containing the updated address details, including street, city, state, and postal code, essential for accurate portfolio and asset management within the Nakisa Portfolio Management Suite.

Body Parameters

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "street": "string",
10  "civicNumber": "string",
11  "suite": "string",
12  "postalCode": "string",
13  "lon": 0.1,
14  "lat": 0.1,
15  "city": {
16    "createdBy": "string",
17    "lastModifiedBy": "string",
18    "createdDate": "2019-08-24T14:15:22Z",
19    "lastModifiedDate": "2019-08-24T14:15:22Z",
20    "archived": true,
21    "externalId": "string",
22    "id": 0,
23    "name": "string",
24    "province": {
25      "createdBy": "string",
26      "lastModifiedBy": "string",
27      "createdDate": "2019-08-24T14:15:22Z",
28      "lastModifiedDate": "2019-08-24T14:15:22Z",
29      "archived": true,
30      "externalId": "string",
31      "id": 0,
32      "name": "string",
33      "code": "string",
34      "country": {
35        "createdBy": "string",
36        "lastModifiedBy": "string",
37        "createdDate": "2019-08-24T14:15:22Z",
38        "lastModifiedDate": "2019-08-24T14:15:22Z",
39        "archived": true,
40        "externalId": "string",
41        "id": 0,
42        "name": "string",
43        "code": "string"
44      },
45      "provinceCountryKey": "string"
46    },
47    "cityProvinceCountryKey": "string"
48  },
49  "district": {
50    "createdBy": "string",
51    "lastModifiedBy": "string",
52    "createdDate": "2019-08-24T14:15:22Z",
53    "lastModifiedDate": "2019-08-24T14:15:22Z",
54    "archived": true,
55    "externalId": "string",
56    "id": 0,
57    "name": "string",
58    "city": {
59      "createdBy": "string",
60      "lastModifiedBy": "string",
61      "createdDate": "2019-08-24T14:15:22Z",
62      "lastModifiedDate": "2019-08-24T14:15:22Z",
63      "archived": true,
64      "externalId": "string",
65      "id": 0,
66      "name": "string",
67      "province": {
68        "createdBy": "string",
69        "lastModifiedBy": "string",
70        "createdDate": "2019-08-24T14:15:22Z",
71        "lastModifiedDate": "2019-08-24T14:15:22Z",
72        "archived": true,
73        "externalId": "string",
74        "id": 0,
75        "name": "string",
76        "code": "string",
77        "country": {
78          "createdBy": "string",
79          "lastModifiedBy": "string",
80          "createdDate": "2019-08-24T14:15:22Z",
81          "lastModifiedDate": "2019-08-24T14:15:22Z",
82          "archived": true,
83          "externalId": "string",
84          "id": 0,
85          "name": "string",
86          "code": "string"
87        },
88        "provinceCountryKey": "string"
89      },
90      "cityProvinceCountryKey": "string"
91    }
92  },
93  "cityId": 0,
94  "districtId": 0
95}

Responses

Status

Meaning

Description

Schema

200

OK

OK

AddressDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "street": "string",
10  "civicNumber": "string",
11  "suite": "string",
12  "postalCode": "string",
13  "lon": 0.1,
14  "lat": 0.1,
15  "city": {
16    "createdBy": "string",
17    "lastModifiedBy": "string",
18    "createdDate": "2019-08-24T14:15:22Z",
19    "lastModifiedDate": "2019-08-24T14:15:22Z",
20    "archived": true,
21    "externalId": "string",
22    "id": 0,
23    "name": "string",
24    "province": {
25      "createdBy": "string",
26      "lastModifiedBy": "string",
27      "createdDate": "2019-08-24T14:15:22Z",
28      "lastModifiedDate": "2019-08-24T14:15:22Z",
29      "archived": true,
30      "externalId": "string",
31      "id": 0,
32      "name": "string",
33      "code": "string",
34      "country": {
35        "createdBy": "string",
36        "lastModifiedBy": "string",
37        "createdDate": "2019-08-24T14:15:22Z",
38        "lastModifiedDate": "2019-08-24T14:15:22Z",
39        "archived": true,
40        "externalId": "string",
41        "id": 0,
42        "name": "string",
43        "code": "string"
44      },
45      "provinceCountryKey": "string"
46    },
47    "cityProvinceCountryKey": "string"
48  },
49  "district": {
50    "createdBy": "string",
51    "lastModifiedBy": "string",
52    "createdDate": "2019-08-24T14:15:22Z",
53    "lastModifiedDate": "2019-08-24T14:15:22Z",
54    "archived": true,
55    "externalId": "string",
56    "id": 0,
57    "name": "string",
58    "city": {
59      "createdBy": "string",
60      "lastModifiedBy": "string",
61      "createdDate": "2019-08-24T14:15:22Z",
62      "lastModifiedDate": "2019-08-24T14:15:22Z",
63      "archived": true,
64      "externalId": "string",
65      "id": 0,
66      "name": "string",
67      "province": {
68        "createdBy": "string",
69        "lastModifiedBy": "string",
70        "createdDate": "2019-08-24T14:15:22Z",
71        "lastModifiedDate": "2019-08-24T14:15:22Z",
72        "archived": true,
73        "externalId": "string",
74        "id": 0,
75        "name": "string",
76        "code": "string",
77        "country": {
78          "createdBy": "string",
79          "lastModifiedBy": "string",
80          "createdDate": "2019-08-24T14:15:22Z",
81          "lastModifiedDate": "2019-08-24T14:15:22Z",
82          "archived": true,
83          "externalId": "string",
84          "id": 0,
85          "name": "string",
86          "code": "string"
87        },
88        "provinceCountryKey": "string"
89      },
90      "cityProvinceCountryKey": "string"
91    }
92  },
93  "cityId": 0,
94  "districtId": 0
95}

Address - Delete Address

HTTP Request

DELETE /api/addresses/{id}

📋 Description: Deletes a specified address from the Nakisa Portfolio Management Suite, ensuring the integrity of portfolio and asset data within the real estate property analytics framework.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None

Address - Get Addresses

HTTP Request

GET /api/addresses

📋 Description: Retrieves a list of addresses associated with real estate assets within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio locations and enhance asset management strategies.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the response should be paginated, facilitating efficient retrieval of address data within the Nakisa Portfolio Management Suite for portfolio and asset management analytics.

search

query

string

false

Search term used to filter and retrieve specific addresses within the Nakisa Portfolio Management Suite, relevant for portfolio, asset, analytics, and real estate property management.

street

query

string

false

Specifies the street address associated with a real estate property within the Nakisa Portfolio Management Suite for portfolio and asset analytics.

civic-number

query

string

false

Unique identifier for the civic address, facilitating accurate retrieval of portfolio and asset data within the Nakisa Portfolio Management Suite.

suite

query

string

false

Specifies the suite within the Nakisa Portfolio Management Suite to filter the retrieved addresses related to portfolio, asset, analytics, and real estate property.

postal-code

query

string

false

Represents the postal code associated with a real estate property, facilitating accurate portfolio and asset analytics within the Nakisa Portfolio Management Suite.

lon

query

string

false

Represents the longitude coordinate used to specify the geographic location of a real estate property within the Nakisa Portfolio Management Suite.

lat

query

string

false

Specifies the latitude coordinate for geolocation purposes, enabling accurate mapping and analytics of real estate properties within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelAddressDto

Example Responses

  1{
  2  "_embedded": {
  3    "addresses": [
  4      {
  5        "createdBy": "string",
  6        "lastModifiedBy": "string",
  7        "createdDate": "2019-08-24T14:15:22Z",
  8        "lastModifiedDate": "2019-08-24T14:15:22Z",
  9        "archived": true,
 10        "externalId": "string",
 11        "id": 0,
 12        "street": "string",
 13        "civicNumber": "string",
 14        "suite": "string",
 15        "postalCode": "string",
 16        "lon": 0.1,
 17        "lat": 0.1,
 18        "city": {
 19          "createdBy": "string",
 20          "lastModifiedBy": "string",
 21          "createdDate": "2019-08-24T14:15:22Z",
 22          "lastModifiedDate": "2019-08-24T14:15:22Z",
 23          "archived": true,
 24          "externalId": "string",
 25          "id": 0,
 26          "name": "string",
 27          "province": {
 28            "createdBy": "string",
 29            "lastModifiedBy": "string",
 30            "createdDate": "2019-08-24T14:15:22Z",
 31            "lastModifiedDate": "2019-08-24T14:15:22Z",
 32            "archived": true,
 33            "externalId": "string",
 34            "id": 0,
 35            "name": "string",
 36            "code": "string",
 37            "country": {
 38              "createdBy": "string",
 39              "lastModifiedBy": "string",
 40              "createdDate": "2019-08-24T14:15:22Z",
 41              "lastModifiedDate": "2019-08-24T14:15:22Z",
 42              "archived": true,
 43              "externalId": "string",
 44              "id": 0,
 45              "name": "string",
 46              "code": "string"
 47            },
 48            "provinceCountryKey": "string"
 49          },
 50          "cityProvinceCountryKey": "string"
 51        },
 52        "district": {
 53          "createdBy": "string",
 54          "lastModifiedBy": "string",
 55          "createdDate": "2019-08-24T14:15:22Z",
 56          "lastModifiedDate": "2019-08-24T14:15:22Z",
 57          "archived": true,
 58          "externalId": "string",
 59          "id": 0,
 60          "name": "string",
 61          "city": {
 62            "createdBy": "string",
 63            "lastModifiedBy": "string",
 64            "createdDate": "2019-08-24T14:15:22Z",
 65            "lastModifiedDate": "2019-08-24T14:15:22Z",
 66            "archived": true,
 67            "externalId": "string",
 68            "id": 0,
 69            "name": "string",
 70            "province": {
 71              "createdBy": "string",
 72              "lastModifiedBy": "string",
 73              "createdDate": "2019-08-24T14:15:22Z",
 74              "lastModifiedDate": "2019-08-24T14:15:22Z",
 75              "archived": true,
 76              "externalId": "string",
 77              "id": 0,
 78              "name": "string",
 79              "code": "string",
 80              "country": {
 81                "createdBy": "string",
 82                "lastModifiedBy": "string",
 83                "createdDate": "2019-08-24T14:15:22Z",
 84                "lastModifiedDate": "2019-08-24T14:15:22Z",
 85                "archived": true,
 86                "externalId": "string",
 87                "id": 0,
 88                "name": "string",
 89                "code": "string"
 90              },
 91              "provinceCountryKey": "string"
 92            },
 93            "cityProvinceCountryKey": "string"
 94          }
 95        },
 96        "cityId": 0,
 97        "districtId": 0
 98      }
 99    ]
100  },
101  "page": {
102    "size": 0,
103    "totalElements": 0,
104    "totalPages": 0,
105    "number": 0
106  }
107}

Address - Add Addresses

HTTP Request

POST /api/addresses

📋 Description: Creates a new address entry within the Nakisa Portfolio Management Suite, enabling users to manage portfolio and asset locations effectively for enhanced analytics and real estate property management.

Parameters

Name

In

Type

Required

Description

body

body

AddressDto

true

Request body containing the address details necessary for portfolio and asset management, including property location, type, and associated analytics.

Body Parameters

 1[
 2  {
 3    "createdBy": "string",
 4    "lastModifiedBy": "string",
 5    "createdDate": "2019-08-24T14:15:22Z",
 6    "lastModifiedDate": "2019-08-24T14:15:22Z",
 7    "archived": true,
 8    "externalId": "string",
 9    "id": 0,
10    "street": "string",
11    "civicNumber": "string",
12    "suite": "string",
13    "postalCode": "string",
14    "lon": 0.1,
15    "lat": 0.1,
16    "city": {
17      "createdBy": "string",
18      "lastModifiedBy": "string",
19      "createdDate": "2019-08-24T14:15:22Z",
20      "lastModifiedDate": "2019-08-24T14:15:22Z",
21      "archived": true,
22      "externalId": "string",
23      "id": 0,
24      "name": "string",
25      "province": {
26        "createdBy": "string",
27        "lastModifiedBy": "string",
28        "createdDate": "2019-08-24T14:15:22Z",
29        "lastModifiedDate": "2019-08-24T14:15:22Z",
30        "archived": true,
31        "externalId": "string",
32        "id": 0,
33        "name": "string",
34        "code": "string",
35        "country": {
36          "createdBy": "string",
37          "lastModifiedBy": "string",
38          "createdDate": "2019-08-24T14:15:22Z",
39          "lastModifiedDate": "2019-08-24T14:15:22Z",
40          "archived": true,
41          "externalId": "string",
42          "id": 0,
43          "name": "string",
44          "code": "string"
45        },
46        "provinceCountryKey": "string"
47      },
48      "cityProvinceCountryKey": "string"
49    },
50    "district": {
51      "createdBy": "string",
52      "lastModifiedBy": "string",
53      "createdDate": "2019-08-24T14:15:22Z",
54      "lastModifiedDate": "2019-08-24T14:15:22Z",
55      "archived": true,
56      "externalId": "string",
57      "id": 0,
58      "name": "string",
59      "city": {
60        "createdBy": "string",
61        "lastModifiedBy": "string",
62        "createdDate": "2019-08-24T14:15:22Z",
63        "lastModifiedDate": "2019-08-24T14:15:22Z",
64        "archived": true,
65        "externalId": "string",
66        "id": 0,
67        "name": "string",
68        "province": {
69          "createdBy": "string",
70          "lastModifiedBy": "string",
71          "createdDate": "2019-08-24T14:15:22Z",
72          "lastModifiedDate": "2019-08-24T14:15:22Z",
73          "archived": true,
74          "externalId": "string",
75          "id": 0,
76          "name": "string",
77          "code": "string",
78          "country": {
79            "createdBy": "string",
80            "lastModifiedBy": "string",
81            "createdDate": "2019-08-24T14:15:22Z",
82            "lastModifiedDate": "2019-08-24T14:15:22Z",
83            "archived": true,
84            "externalId": "string",
85            "id": 0,
86            "name": "string",
87            "code": "string"
88          },
89          "provinceCountryKey": "string"
90        },
91        "cityProvinceCountryKey": "string"
92      }
93    },
94    "cityId": 0,
95    "districtId": 0
96  }
97]

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Example Responses

 1[
 2  {
 3    "createdBy": "string",
 4    "lastModifiedBy": "string",
 5    "createdDate": "2019-08-24T14:15:22Z",
 6    "lastModifiedDate": "2019-08-24T14:15:22Z",
 7    "archived": true,
 8    "externalId": "string",
 9    "id": 0,
10    "street": "string",
11    "civicNumber": "string",
12    "suite": "string",
13    "postalCode": "string",
14    "lon": 0.1,
15    "lat": 0.1,
16    "city": {
17      "createdBy": "string",
18      "lastModifiedBy": "string",
19      "createdDate": "2019-08-24T14:15:22Z",
20      "lastModifiedDate": "2019-08-24T14:15:22Z",
21      "archived": true,
22      "externalId": "string",
23      "id": 0,
24      "name": "string",
25      "province": {
26        "createdBy": "string",
27        "lastModifiedBy": "string",
28        "createdDate": "2019-08-24T14:15:22Z",
29        "lastModifiedDate": "2019-08-24T14:15:22Z",
30        "archived": true,
31        "externalId": "string",
32        "id": 0,
33        "name": "string",
34        "code": "string",
35        "country": {
36          "createdBy": "string",
37          "lastModifiedBy": "string",
38          "createdDate": "2019-08-24T14:15:22Z",
39          "lastModifiedDate": "2019-08-24T14:15:22Z",
40          "archived": true,
41          "externalId": "string",
42          "id": 0,
43          "name": "string",
44          "code": "string"
45        },
46        "provinceCountryKey": "string"
47      },
48      "cityProvinceCountryKey": "string"
49    },
50    "district": {
51      "createdBy": "string",
52      "lastModifiedBy": "string",
53      "createdDate": "2019-08-24T14:15:22Z",
54      "lastModifiedDate": "2019-08-24T14:15:22Z",
55      "archived": true,
56      "externalId": "string",
57      "id": 0,
58      "name": "string",
59      "city": {
60        "createdBy": "string",
61        "lastModifiedBy": "string",
62        "createdDate": "2019-08-24T14:15:22Z",
63        "lastModifiedDate": "2019-08-24T14:15:22Z",
64        "archived": true,
65        "externalId": "string",
66        "id": 0,
67        "name": "string",
68        "province": {
69          "createdBy": "string",
70          "lastModifiedBy": "string",
71          "createdDate": "2019-08-24T14:15:22Z",
72          "lastModifiedDate": "2019-08-24T14:15:22Z",
73          "archived": true,
74          "externalId": "string",
75          "id": 0,
76          "name": "string",
77          "code": "string",
78          "country": {
79            "createdBy": "string",
80            "lastModifiedBy": "string",
81            "createdDate": "2019-08-24T14:15:22Z",
82            "lastModifiedDate": "2019-08-24T14:15:22Z",
83            "archived": true,
84            "externalId": "string",
85            "id": 0,
86            "name": "string",
87            "code": "string"
88          },
89          "provinceCountryKey": "string"
90        },
91        "cityProvinceCountryKey": "string"
92      }
93    },
94    "cityId": 0,
95    "districtId": 0
96  }
97]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[AddressDto]

false

none

[Data transfer object representing the address details associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics.]

» createdBy

string

false

none

Username of who created this resource

» lastModifiedBy

string

false

none

Username of who last modified this resource

» createdDate

string(date-time)

false

none

Date of the created

» lastModifiedDate

string(date-time)

false

none

Date of the last modified

» archived

boolean

false

none

Boolean flag indicating archived status

» externalId

string

false

none

Unique identifier for the external

» id

integer(int64)

false

none

Unique identifier for the resource

» street

string

false

none

Represents the street address of a real estate property within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics.

» civicNumber

string

false

none

The civicNumber field represents the official identification number assigned to a real estate property, facilitating accurate portfolio management and asset analytics within the Nakisa Portfolio Management Suite.

» suite

string

false

none

Represents the name of the suite associated with the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite, facilitating comprehensive analytics and management.

» postalCode

string

false

none

Code for the postal

» lon

number(double)

false

none

Value for lon field

» lat

number(double)

false

none

Value for lat field

» city

City

false

none

Data transfer object representing a city within the Nakisa Portfolio Management Suite, encapsulating essential information related to real estate properties, portfolio management, and asset analytics. This object facilitates informed decision-making and strategic planning in urban asset management.

»» createdBy

string

false

none

Username of who created this resource

»» lastModifiedBy

string

false

none

Username of who last modified this resource

»» createdDate

string(date-time)

false

none

Date of the created

»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»» archived

boolean

false

none

Boolean flag indicating archived status

»» externalId

string

false

none

Unique identifier for the external

»» id

integer(int64)

false

none

Unique identifier for the resource

»» name

string

true

none

Name of the resource

»» province

Province

false

none

Data transfer object representing a province within the Nakisa Portfolio Management Suite, encapsulating essential details for portfolio analysis and asset management in the context of real estate properties.

»»» createdBy

string

false

none

Username of who created this resource

»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»» createdDate

string(date-time)

false

none

Date of the created

»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»» archived

boolean

false

none

Boolean flag indicating archived status

»»» externalId

string

false

none

Unique identifier for the external

»»» id

integer(int64)

false

none

Unique identifier for the resource

»»» name

string

true

none

Name of the resource

»»» code

string

false

none

Code identifier for the resource

»»» country

Country

false

none

Data transfer object representing a country within the Nakisa Portfolio Management Suite, utilized for portfolio analysis and asset management in the context of real estate properties and analytics.

»»»» createdBy

string

false

none

Username of who created this resource

»»»» lastModifiedBy

string

false

none

Username of who last modified this resource

»»»» createdDate

string(date-time)

false

none

Date of the created

»»»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»»»» archived

boolean

false

none

Boolean flag indicating archived status

»»»» externalId

string

false

none

Unique identifier for the external

»»»» id

integer(int64)

false

none

Unique identifier for the resource

»»»» name

string

true

none

Name of the resource

»»»» code

string

false

none

Code identifier for the resource

»»» provinceCountryKey

string

false

none

none

»» cityProvinceCountryKey

string

false

none

none

» district

District

false

none

Data transfer object representing a district within the Nakisa Portfolio Management Suite, encompassing key attributes related to portfolio management, asset allocation, and real estate property analytics.

»» createdBy

string

false

none

Username of who created this resource

»» lastModifiedBy

string

false

none

Username of who last modified this resource

»» createdDate

string(date-time)

false

none

Date of the created

»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»» archived

boolean

false

none

Boolean flag indicating archived status

»» externalId

string

false

none

Unique identifier for the external

»» id

integer(int64)

false

none

Unique identifier for the resource

»» name

string

true

none

Name of the resource

»» city

City

false

none

Data transfer object representing a city within the Nakisa Portfolio Management Suite, encapsulating essential information related to real estate properties, portfolio management, and asset analytics. This object facilitates informed decision-making and strategic planning in urban asset management.

» cityId

integer(int64)

false

none

Unique identifier for the city

» districtId

integer(int64)

false

none

Unique identifier for the district

Address - Archive Address

HTTP Request

POST /api/addresses/{id}/archive

📋 Description: Archives the specified address within the Nakisa Portfolio Management Suite, facilitating streamlined asset management and enhancing portfolio analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

AddressDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "street": "string",
10  "civicNumber": "string",
11  "suite": "string",
12  "postalCode": "string",
13  "lon": 0.1,
14  "lat": 0.1,
15  "city": {
16    "createdBy": "string",
17    "lastModifiedBy": "string",
18    "createdDate": "2019-08-24T14:15:22Z",
19    "lastModifiedDate": "2019-08-24T14:15:22Z",
20    "archived": true,
21    "externalId": "string",
22    "id": 0,
23    "name": "string",
24    "province": {
25      "createdBy": "string",
26      "lastModifiedBy": "string",
27      "createdDate": "2019-08-24T14:15:22Z",
28      "lastModifiedDate": "2019-08-24T14:15:22Z",
29      "archived": true,
30      "externalId": "string",
31      "id": 0,
32      "name": "string",
33      "code": "string",
34      "country": {
35        "createdBy": "string",
36        "lastModifiedBy": "string",
37        "createdDate": "2019-08-24T14:15:22Z",
38        "lastModifiedDate": "2019-08-24T14:15:22Z",
39        "archived": true,
40        "externalId": "string",
41        "id": 0,
42        "name": "string",
43        "code": "string"
44      },
45      "provinceCountryKey": "string"
46    },
47    "cityProvinceCountryKey": "string"
48  },
49  "district": {
50    "createdBy": "string",
51    "lastModifiedBy": "string",
52    "createdDate": "2019-08-24T14:15:22Z",
53    "lastModifiedDate": "2019-08-24T14:15:22Z",
54    "archived": true,
55    "externalId": "string",
56    "id": 0,
57    "name": "string",
58    "city": {
59      "createdBy": "string",
60      "lastModifiedBy": "string",
61      "createdDate": "2019-08-24T14:15:22Z",
62      "lastModifiedDate": "2019-08-24T14:15:22Z",
63      "archived": true,
64      "externalId": "string",
65      "id": 0,
66      "name": "string",
67      "province": {
68        "createdBy": "string",
69        "lastModifiedBy": "string",
70        "createdDate": "2019-08-24T14:15:22Z",
71        "lastModifiedDate": "2019-08-24T14:15:22Z",
72        "archived": true,
73        "externalId": "string",
74        "id": 0,
75        "name": "string",
76        "code": "string",
77        "country": {
78          "createdBy": "string",
79          "lastModifiedBy": "string",
80          "createdDate": "2019-08-24T14:15:22Z",
81          "lastModifiedDate": "2019-08-24T14:15:22Z",
82          "archived": true,
83          "externalId": "string",
84          "id": 0,
85          "name": "string",
86          "code": "string"
87        },
88        "provinceCountryKey": "string"
89      },
90      "cityProvinceCountryKey": "string"
91    }
92  },
93  "cityId": 0,
94  "districtId": 0
95}

Address - Get Addresses (with Cities, Addresses and City Id)

HTTP Request

GET /api/cities/{cityId}/addresses

📋 Description: Retrieves a list of addresses associated with a specified city, enabling users to analyze real estate property locations within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results for addresses associated with the specified city should be returned in a paginated format, facilitating efficient data retrieval in the context of portfolio and asset management.

cityId

path

string

true

Unique identifier for the city

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelAddressDto

Example Responses

  1{
  2  "_embedded": {
  3    "addresses": [
  4      {
  5        "createdBy": "string",
  6        "lastModifiedBy": "string",
  7        "createdDate": "2019-08-24T14:15:22Z",
  8        "lastModifiedDate": "2019-08-24T14:15:22Z",
  9        "archived": true,
 10        "externalId": "string",
 11        "id": 0,
 12        "street": "string",
 13        "civicNumber": "string",
 14        "suite": "string",
 15        "postalCode": "string",
 16        "lon": 0.1,
 17        "lat": 0.1,
 18        "city": {
 19          "createdBy": "string",
 20          "lastModifiedBy": "string",
 21          "createdDate": "2019-08-24T14:15:22Z",
 22          "lastModifiedDate": "2019-08-24T14:15:22Z",
 23          "archived": true,
 24          "externalId": "string",
 25          "id": 0,
 26          "name": "string",
 27          "province": {
 28            "createdBy": "string",
 29            "lastModifiedBy": "string",
 30            "createdDate": "2019-08-24T14:15:22Z",
 31            "lastModifiedDate": "2019-08-24T14:15:22Z",
 32            "archived": true,
 33            "externalId": "string",
 34            "id": 0,
 35            "name": "string",
 36            "code": "string",
 37            "country": {
 38              "createdBy": "string",
 39              "lastModifiedBy": "string",
 40              "createdDate": "2019-08-24T14:15:22Z",
 41              "lastModifiedDate": "2019-08-24T14:15:22Z",
 42              "archived": true,
 43              "externalId": "string",
 44              "id": 0,
 45              "name": "string",
 46              "code": "string"
 47            },
 48            "provinceCountryKey": "string"
 49          },
 50          "cityProvinceCountryKey": "string"
 51        },
 52        "district": {
 53          "createdBy": "string",
 54          "lastModifiedBy": "string",
 55          "createdDate": "2019-08-24T14:15:22Z",
 56          "lastModifiedDate": "2019-08-24T14:15:22Z",
 57          "archived": true,
 58          "externalId": "string",
 59          "id": 0,
 60          "name": "string",
 61          "city": {
 62            "createdBy": "string",
 63            "lastModifiedBy": "string",
 64            "createdDate": "2019-08-24T14:15:22Z",
 65            "lastModifiedDate": "2019-08-24T14:15:22Z",
 66            "archived": true,
 67            "externalId": "string",
 68            "id": 0,
 69            "name": "string",
 70            "province": {
 71              "createdBy": "string",
 72              "lastModifiedBy": "string",
 73              "createdDate": "2019-08-24T14:15:22Z",
 74              "lastModifiedDate": "2019-08-24T14:15:22Z",
 75              "archived": true,
 76              "externalId": "string",
 77              "id": 0,
 78              "name": "string",
 79              "code": "string",
 80              "country": {
 81                "createdBy": "string",
 82                "lastModifiedBy": "string",
 83                "createdDate": "2019-08-24T14:15:22Z",
 84                "lastModifiedDate": "2019-08-24T14:15:22Z",
 85                "archived": true,
 86                "externalId": "string",
 87                "id": 0,
 88                "name": "string",
 89                "code": "string"
 90              },
 91              "provinceCountryKey": "string"
 92            },
 93            "cityProvinceCountryKey": "string"
 94          }
 95        },
 96        "cityId": 0,
 97        "districtId": 0
 98      }
 99    ]
100  },
101  "page": {
102    "size": 0,
103    "totalElements": 0,
104    "totalPages": 0,
105    "number": 0
106  }
107}

Address - Get Address Options

HTTP Request

GET /api/addresses/geo-search

📋 Description: Fetches geolocation data for addresses within the Nakisa Portfolio Management Suite, enabling users to analyze and visualize real estate properties in relation to their portfolio and asset management strategies.

Parameters

Name

In

Type

Required

Description

query

query

string

true

Search term used to filter and retrieve geographic address data relevant to portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

1{
2  "property1": "string",
3  "property2": "string"
4}

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

» additionalProperties

string

false

none

none

Address - Get Address Details

HTTP Request

GET /api/addresses/geo-details

📋 Description: Retrieves geographical details for specified addresses within the Nakisa Portfolio Management Suite, enabling enhanced analytics and insights for portfolio and asset management in the real estate sector.

Parameters

Name

In

Type

Required

Description

place_id

query

integer(int32)

true

Unique identifier for the specific real estate property within the Nakisa Portfolio Management Suite, used to retrieve detailed geographic information.

Responses

Status

Meaning

Description

Schema

200

OK

OK

AddressDetailsDto

Example Responses

 1{
 2  "civicNumber": "string",
 3  "street": "string",
 4  "postalCode": "string",
 5  "city": {
 6    "createdBy": "string",
 7    "lastModifiedBy": "string",
 8    "createdDate": "2019-08-24T14:15:22Z",
 9    "lastModifiedDate": "2019-08-24T14:15:22Z",
10    "archived": true,
11    "externalId": "string",
12    "id": 0,
13    "name": "string",
14    "province": {
15      "createdBy": "string",
16      "lastModifiedBy": "string",
17      "createdDate": "2019-08-24T14:15:22Z",
18      "lastModifiedDate": "2019-08-24T14:15:22Z",
19      "archived": true,
20      "externalId": "string",
21      "id": 0,
22      "name": "string",
23      "country": {
24        "createdBy": "string",
25        "lastModifiedBy": "string",
26        "createdDate": "2019-08-24T14:15:22Z",
27        "lastModifiedDate": "2019-08-24T14:15:22Z",
28        "archived": true,
29        "externalId": "string",
30        "id": 0,
31        "name": "string",
32        "code": "string"
33      },
34      "code": "string",
35      "countryId": 0
36    },
37    "provinceId": 0
38  }
39}