City¶
Get City¶
HTTP Request
GET /api/cities/{id}
📋 Description: Retrieves detailed information about a specific city within the Nakisa Portfolio Management Suite, enabling users to analyze real estate properties and assets associated with that location.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "name": "string",
10 "province": {
11 "createdBy": "string",
12 "lastModifiedBy": "string",
13 "createdDate": "2019-08-24T14:15:22Z",
14 "lastModifiedDate": "2019-08-24T14:15:22Z",
15 "archived": true,
16 "externalId": "string",
17 "id": 0,
18 "name": "string",
19 "country": {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "name": "string",
28 "code": "string"
29 },
30 "code": "string",
31 "countryId": 0
32 },
33 "provinceId": 0
34}
Update City¶
HTTP Request
PUT /api/cities/{id}
📋 Description: Updates the details of a specified city within the Nakisa Portfolio Management Suite, enabling users to manage real estate property data effectively within their portfolio and analytics frameworks.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated city information, including attributes related to portfolio management and asset analytics for real estate properties. |
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 "name": "string",
10 "province": {
11 "createdBy": "string",
12 "lastModifiedBy": "string",
13 "createdDate": "2019-08-24T14:15:22Z",
14 "lastModifiedDate": "2019-08-24T14:15:22Z",
15 "archived": true,
16 "externalId": "string",
17 "id": 0,
18 "name": "string",
19 "country": {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "name": "string",
28 "code": "string"
29 },
30 "code": "string",
31 "countryId": 0
32 },
33 "provinceId": 0
34}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "name": "string",
10 "province": {
11 "createdBy": "string",
12 "lastModifiedBy": "string",
13 "createdDate": "2019-08-24T14:15:22Z",
14 "lastModifiedDate": "2019-08-24T14:15:22Z",
15 "archived": true,
16 "externalId": "string",
17 "id": 0,
18 "name": "string",
19 "country": {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "name": "string",
28 "code": "string"
29 },
30 "code": "string",
31 "countryId": 0
32 },
33 "provinceId": 0
34}
Delete City¶
HTTP Request
DELETE /api/cities/{id}
📋 Description: Deletes a specified city from the Nakisa Portfolio Management Suite, ensuring the removal of associated data within the portfolio and asset analytics related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get Cities¶
HTTP Request
GET /api/cities
📋 Description: Retrieves a list of cities relevant to the Nakisa Portfolio Management Suite, facilitating portfolio analysis and asset management within the real estate property sector.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the city data retrieval should be paginated, facilitating efficient navigation through large datasets within the Nakisa Portfolio Management Suite. |
|
name |
query |
string |
false |
Name of the resource |
province-id |
query |
string |
false |
Unique identifier for the province, used to filter and retrieve cities within the specified province in the Nakisa Portfolio Management Suite. |
province-id-in |
query |
string |
false |
Unique identifier for the province, used to filter and retrieve cities associated with specific regions within the Nakisa Portfolio Management Suite. |
country-id-in |
query |
string |
false |
Unique identifier for the country, used to filter and retrieve city data relevant to the specified country within the Nakisa Portfolio Management Suite. |
id-in |
query |
string |
false |
Unique identifier for the city within the Nakisa Portfolio Management Suite, used to retrieve specific city data related to portfolio, asset, and real estate property analytics. |
search |
query |
string |
false |
Search term used to filter and retrieve specific cities within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics in the real estate property domain. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "cities": [
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 "name": "string",
13 "province": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "name": "string",
22 "country": {
23 "createdBy": "string",
24 "lastModifiedBy": "string",
25 "createdDate": "2019-08-24T14:15:22Z",
26 "lastModifiedDate": "2019-08-24T14:15:22Z",
27 "archived": true,
28 "externalId": "string",
29 "id": 0,
30 "name": "string",
31 "code": "string"
32 },
33 "code": "string",
34 "countryId": 0
35 },
36 "provinceId": 0
37 }
38 ]
39 },
40 "page": {
41 "size": 0,
42 "totalElements": 0,
43 "totalPages": 0,
44 "number": 0
45 }
46}
Add Cities¶
HTTP Request
POST /api/cities
📋 Description: Creates a new city entry within the Nakisa Portfolio Management Suite, enabling enhanced portfolio and asset analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing detailed information about the city, including its name, geographical data, and relevant portfolio attributes for effective asset and analytics management within the Nakisa Portfolio Management Suite. |
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 "name": "string",
11 "province": {
12 "createdBy": "string",
13 "lastModifiedBy": "string",
14 "createdDate": "2019-08-24T14:15:22Z",
15 "lastModifiedDate": "2019-08-24T14:15:22Z",
16 "archived": true,
17 "externalId": "string",
18 "id": 0,
19 "name": "string",
20 "country": {
21 "createdBy": "string",
22 "lastModifiedBy": "string",
23 "createdDate": "2019-08-24T14:15:22Z",
24 "lastModifiedDate": "2019-08-24T14:15:22Z",
25 "archived": true,
26 "externalId": "string",
27 "id": 0,
28 "name": "string",
29 "code": "string"
30 },
31 "code": "string",
32 "countryId": 0
33 },
34 "provinceId": 0
35 }
36]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
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 "name": "string",
11 "province": {
12 "createdBy": "string",
13 "lastModifiedBy": "string",
14 "createdDate": "2019-08-24T14:15:22Z",
15 "lastModifiedDate": "2019-08-24T14:15:22Z",
16 "archived": true,
17 "externalId": "string",
18 "id": 0,
19 "name": "string",
20 "country": {
21 "createdBy": "string",
22 "lastModifiedBy": "string",
23 "createdDate": "2019-08-24T14:15:22Z",
24 "lastModifiedDate": "2019-08-24T14:15:22Z",
25 "archived": true,
26 "externalId": "string",
27 "id": 0,
28 "name": "string",
29 "code": "string"
30 },
31 "code": "string",
32 "countryId": 0
33 },
34 "provinceId": 0
35 }
36]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a city within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio, asset management, and analytics for 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 |
» province |
false |
none |
Data transfer object representing a province within the Nakisa Portfolio Management Suite, encapsulating essential information for portfolio analysis, asset management, 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 |
»» country |
false |
none |
Data transfer object representing a country within the Nakisa Portfolio Management Suite, providing essential information for portfolio analysis, asset management, and real estate property evaluations. |
|
»»» 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 |
»» code |
string |
false |
none |
Code identifier for the resource |
»» countryId |
integer(int64) |
true |
none |
Unique identifier for the country |
» provinceId |
integer(int64) |
true |
none |
Unique identifier for the province |
Update Cities¶
HTTP Request
PATCH /api/cities
📋 Description: Updates the details of existing cities within the Nakisa Portfolio Management Suite, enabling users to manage portfolio and asset information effectively in the context of real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the updated city information, including portfolio identifiers and asset analytics relevant to real estate property management. |
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 "name": "string",
11 "province": {
12 "createdBy": "string",
13 "lastModifiedBy": "string",
14 "createdDate": "2019-08-24T14:15:22Z",
15 "lastModifiedDate": "2019-08-24T14:15:22Z",
16 "archived": true,
17 "externalId": "string",
18 "id": 0,
19 "name": "string",
20 "country": {
21 "createdBy": "string",
22 "lastModifiedBy": "string",
23 "createdDate": "2019-08-24T14:15:22Z",
24 "lastModifiedDate": "2019-08-24T14:15:22Z",
25 "archived": true,
26 "externalId": "string",
27 "id": 0,
28 "name": "string",
29 "code": "string"
30 },
31 "code": "string",
32 "countryId": 0
33 },
34 "provinceId": 0
35 }
36]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "name": "string",
11 "province": {
12 "createdBy": "string",
13 "lastModifiedBy": "string",
14 "createdDate": "2019-08-24T14:15:22Z",
15 "lastModifiedDate": "2019-08-24T14:15:22Z",
16 "archived": true,
17 "externalId": "string",
18 "id": 0,
19 "name": "string",
20 "country": {
21 "createdBy": "string",
22 "lastModifiedBy": "string",
23 "createdDate": "2019-08-24T14:15:22Z",
24 "lastModifiedDate": "2019-08-24T14:15:22Z",
25 "archived": true,
26 "externalId": "string",
27 "id": 0,
28 "name": "string",
29 "code": "string"
30 },
31 "code": "string",
32 "countryId": 0
33 },
34 "provinceId": 0
35 }
36]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a city within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio, asset management, and analytics for 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 |
» province |
false |
none |
Data transfer object representing a province within the Nakisa Portfolio Management Suite, encapsulating essential information for portfolio analysis, asset management, 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 |
»» country |
false |
none |
Data transfer object representing a country within the Nakisa Portfolio Management Suite, providing essential information for portfolio analysis, asset management, and real estate property evaluations. |
|
»»» 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 |
»» code |
string |
false |
none |
Code identifier for the resource |
»» countryId |
integer(int64) |
true |
none |
Unique identifier for the country |
» provinceId |
integer(int64) |
true |
none |
Unique identifier for the province |
Archive City¶
HTTP Request
POST /api/cities/{id}/archive
📋 Description: Archives a specified city within the Nakisa Portfolio Management Suite, facilitating the management of real estate assets and enhancing portfolio analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "name": "string",
10 "province": {
11 "createdBy": "string",
12 "lastModifiedBy": "string",
13 "createdDate": "2019-08-24T14:15:22Z",
14 "lastModifiedDate": "2019-08-24T14:15:22Z",
15 "archived": true,
16 "externalId": "string",
17 "id": 0,
18 "name": "string",
19 "country": {
20 "createdBy": "string",
21 "lastModifiedBy": "string",
22 "createdDate": "2019-08-24T14:15:22Z",
23 "lastModifiedDate": "2019-08-24T14:15:22Z",
24 "archived": true,
25 "externalId": "string",
26 "id": 0,
27 "name": "string",
28 "code": "string"
29 },
30 "code": "string",
31 "countryId": 0
32 },
33 "provinceId": 0
34}
Get Cities¶
HTTP Request
GET /api/provinces/{provinceId}/cities
📋 Description: Retrieves a list of cities associated with a specified province, enabling users to analyze geographic distribution and asset allocation within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results for cities within the specified province should be returned in a paginated format, enhancing data management and user experience in the Nakisa Portfolio Management Suite. |
|
provinceId |
path |
string |
true |
Unique identifier for the province |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "cities": [
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 "name": "string",
13 "province": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "name": "string",
22 "country": {
23 "createdBy": "string",
24 "lastModifiedBy": "string",
25 "createdDate": "2019-08-24T14:15:22Z",
26 "lastModifiedDate": "2019-08-24T14:15:22Z",
27 "archived": true,
28 "externalId": "string",
29 "id": 0,
30 "name": "string",
31 "code": "string"
32 },
33 "code": "string",
34 "countryId": 0
35 },
36 "provinceId": 0
37 }
38 ]
39 },
40 "page": {
41 "size": 0,
42 "totalElements": 0,
43 "totalPages": 0,
44 "number": 0
45 }
46}