Province

Get Province

HTTP Request

GET /api/provinces/{id}

📋 Description: Retrieves detailed information about a specific province within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio assets and real estate properties effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

ProvinceDto

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  "country": {
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    "code": "string"
20  },
21  "code": "string",
22  "countryId": 0
23}

Update Province

HTTP Request

PUT /api/provinces/{id}

📋 Description: Updates the details of a specified province 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

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ProvinceDto

true

Request body containing updated province information, including name, region, and associated portfolio details for effective asset and analytics 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  "name": "string",
10  "country": {
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    "code": "string"
20  },
21  "code": "string",
22  "countryId": 0
23}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ProvinceDto

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  "country": {
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    "code": "string"
20  },
21  "code": "string",
22  "countryId": 0
23}

Delete Province

HTTP Request

DELETE /api/provinces/{id}

📋 Description: Deletes a specified province 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

Get Provinces

HTTP Request

GET /api/provinces

📋 Description: Retrieves a list of provinces relevant to the Nakisa Portfolio Management Suite, providing essential geographic data for portfolio analysis and asset management in the real estate sector.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the provinces query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics.

search

query

string

false

Search term used to filter and retrieve specific provinces within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics related to real estate properties.

name

query

string

false

Name of the resource

search-name

query

string

false

Specifies the name of the province to filter the list of provinces returned by the Nakisa Portfolio Management Suite, facilitating targeted portfolio and asset analytics in the real estate property sector.

code

query

string

false

Code identifier for the resource

country-id

query

string

false

Unique identifier for the country, used to filter and retrieve province data relevant to portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.

country-id-in

query

string

false

Unique identifier for the country, used to filter and retrieve province data within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties.

id-in

query

string

false

Unique identifier for a specific province within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of portfolio, asset, and analytics data related to real estate properties.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelProvinceDto

Example Responses

 1{
 2  "_embedded": {
 3    "provinces": [
 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        "country": {
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          "code": "string"
23        },
24        "code": "string",
25        "countryId": 0
26      }
27    ]
28  },
29  "page": {
30    "size": 0,
31    "totalElements": 0,
32    "totalPages": 0,
33    "number": 0
34  }
35}

Add Provinces

HTTP Request

POST /api/provinces

📋 Description: Creates a new province entry within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

ProvinceDto

true

Request body containing the province details, including name, code, and associated portfolio information, essential for managing real estate assets and analytics 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    "country": {
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      "code": "string"
21    },
22    "code": "string",
23    "countryId": 0
24  }
25]

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    "name": "string",
11    "country": {
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      "code": "string"
21    },
22    "code": "string",
23    "countryId": 0
24  }
25]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[ProvinceDto]

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

CountryDto

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

Archive Province

HTTP Request

POST /api/provinces/{id}/archive

📋 Description: Archives a specified province within the Nakisa Portfolio Management Suite, facilitating effective asset management and 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

ProvinceDto

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  "country": {
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    "code": "string"
20  },
21  "code": "string",
22  "countryId": 0
23}

Get Provinces

HTTP Request

GET /api/countries/{countryId}/provinces

📋 Description: Retrieves a list of provinces associated with a specified country, enabling users to analyze regional asset distribution within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the response should be paginated, allowing users to efficiently retrieve and manage large sets of provincial data within the context of portfolio and asset analytics.

countryId

path

string

true

Unique identifier for the country

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelProvinceDto

Example Responses

 1{
 2  "_embedded": {
 3    "provinces": [
 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        "country": {
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          "code": "string"
23        },
24        "code": "string",
25        "countryId": 0
26      }
27    ]
28  },
29  "page": {
30    "size": 0,
31    "totalElements": 0,
32    "totalPages": 0,
33    "number": 0
34  }
35}