Country¶
Country - Get Country¶
HTTP Request
GET /api/countries/{id}
📋 Description: Retrieves detailed information about a specific country identified by the unique ID, facilitating insights into portfolio and asset management within the Nakisa Portfolio Management Suite.
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 "code": "string"
11}
Country - Update Country¶
HTTP Request
PUT /api/countries/{id}
📋 Description: Updates the details of a specified country within the Nakisa Portfolio Management Suite, enabling users to manage portfolio, asset, and analytics data related to real estate properties effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated country information, including attributes relevant 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 "code": "string"
11}
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 "code": "string"
11}
Country - Delete Country¶
HTTP Request
DELETE /api/countries/{id}
📋 Description: Deletes a specified country from the Nakisa Portfolio Management Suite, ensuring that portfolio and asset data remains accurate and up-to-date for real estate property analytics.
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 |
Country - Get Countries¶
HTTP Request
GET /api/countries
📋 Description: Retrieves a list of countries 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 country data retrieval should be paginated, enhancing the efficiency of data access within the Nakisa Portfolio Management Suite for portfolio and asset analytics. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific country data within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
name |
query |
string |
false |
Name of the resource |
search-name |
query |
string |
false |
Specifies the name of the country to filter the results in the portfolio management suite, enhancing asset and analytics retrieval for real estate properties. |
code |
query |
string |
false |
Code identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "countries": [
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 "code": "string"
14 }
15 ]
16 },
17 "page": {
18 "size": 0,
19 "totalElements": 0,
20 "totalPages": 0,
21 "number": 0
22 }
23}
Country - Add Countries¶
HTTP Request
POST /api/countries
📋 Description: Creates a new country entry in 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 the country details, including name, code, and relevant portfolio attributes, for integration into 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 "code": "string"
12 }
13]
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 "code": "string"
12 }
13]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
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 |
Country - Archive Country¶
HTTP Request
POST /api/countries/{id}/archive
📋 Description: Archives a specified country within the Nakisa Portfolio Management Suite, facilitating streamlined portfolio management and analytics for real estate assets.
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 "code": "string"
11}