Project Geographic Definition

Get Project Geographic Definition

HTTP Request

GET /api/project-geo-definitions/{id}

📋 Description: Retrieves the geographic definitions associated with a specific project, enabling users to analyze portfolio and asset data 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

OK

ProjectGeographicDefinitionDto

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  "cityId": 0,
10  "area": "string",
11  "addressTrafficTypeId": 0,
12  "intersection": "string",
13  "shapeCoordinates": "string",
14  "city": {
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    "province": {
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      "country": {
33        "createdBy": "string",
34        "lastModifiedBy": "string",
35        "createdDate": "2019-08-24T14:15:22Z",
36        "lastModifiedDate": "2019-08-24T14:15:22Z",
37        "archived": true,
38        "externalId": "string",
39        "id": 0,
40        "name": "string",
41        "code": "string"
42      },
43      "code": "string",
44      "countryId": 0
45    },
46    "provinceId": 0
47  },
48  "projectId": 0,
49  "addressTrafficType": {
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    "priority": 0,
58    "internalId": 0,
59    "pickListCode": "string",
60    "pickListLabel": "string",
61    "label": "string",
62    "cultureId": 0,
63    "labelDtos": [
64      {
65        "createdBy": "string",
66        "lastModifiedBy": "string",
67        "createdDate": "2019-08-24T14:15:22Z",
68        "lastModifiedDate": "2019-08-24T14:15:22Z",
69        "archived": true,
70        "externalId": "string",
71        "id": 0,
72        "cultureId": 0,
73        "value": "string"
74      }
75    ]
76  }
77}

Update Project Geographic Definition

HTTP Request

PUT /api/project-geo-definitions/{id}

📋 Description: Updates the geographic definitions for a specified project within the Nakisa Portfolio Management Suite, enabling enhanced asset analytics and portfolio management for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ProjectGeographicDefinitionDto

true

Request body containing the updated geographical definition data for a specific project, including attributes relevant to portfolio management and asset analytics.

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  "cityId": 0,
10  "area": "string",
11  "addressTrafficTypeId": 0,
12  "intersection": "string",
13  "shapeCoordinates": "string",
14  "city": {
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    "province": {
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      "country": {
33        "createdBy": "string",
34        "lastModifiedBy": "string",
35        "createdDate": "2019-08-24T14:15:22Z",
36        "lastModifiedDate": "2019-08-24T14:15:22Z",
37        "archived": true,
38        "externalId": "string",
39        "id": 0,
40        "name": "string",
41        "code": "string"
42      },
43      "code": "string",
44      "countryId": 0
45    },
46    "provinceId": 0
47  },
48  "projectId": 0,
49  "addressTrafficType": {
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    "priority": 0,
58    "internalId": 0,
59    "pickListCode": "string",
60    "pickListLabel": "string",
61    "label": "string",
62    "cultureId": 0,
63    "labelDtos": [
64      {
65        "createdBy": "string",
66        "lastModifiedBy": "string",
67        "createdDate": "2019-08-24T14:15:22Z",
68        "lastModifiedDate": "2019-08-24T14:15:22Z",
69        "archived": true,
70        "externalId": "string",
71        "id": 0,
72        "cultureId": 0,
73        "value": "string"
74      }
75    ]
76  }
77}

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Delete Project Geographic Definition

HTTP Request

DELETE /api/project-geo-definitions/{id}

📋 Description: Deletes a specified geographic definition from the portfolio management system, ensuring accurate asset analytics and real estate property data management.

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

Create Project Geographic Definition DTO

HTTP Request

POST /api/project-geo-definitions

📋 Description: Creates new geographic definitions for projects within the Nakisa Portfolio Management Suite, enabling enhanced asset tracking and analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

ProjectGeographicDefinitionDto

true

Request body containing geographic definitions for portfolio assets, including relevant analytics and real estate property attributes.

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  "cityId": 0,
10  "area": "string",
11  "addressTrafficTypeId": 0,
12  "intersection": "string",
13  "shapeCoordinates": "string",
14  "city": {
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    "province": {
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      "country": {
33        "createdBy": "string",
34        "lastModifiedBy": "string",
35        "createdDate": "2019-08-24T14:15:22Z",
36        "lastModifiedDate": "2019-08-24T14:15:22Z",
37        "archived": true,
38        "externalId": "string",
39        "id": 0,
40        "name": "string",
41        "code": "string"
42      },
43      "code": "string",
44      "countryId": 0
45    },
46    "provinceId": 0
47  },
48  "projectId": 0,
49  "addressTrafficType": {
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    "priority": 0,
58    "internalId": 0,
59    "pickListCode": "string",
60    "pickListLabel": "string",
61    "label": "string",
62    "cultureId": 0,
63    "labelDtos": [
64      {
65        "createdBy": "string",
66        "lastModifiedBy": "string",
67        "createdDate": "2019-08-24T14:15:22Z",
68        "lastModifiedDate": "2019-08-24T14:15:22Z",
69        "archived": true,
70        "externalId": "string",
71        "id": 0,
72        "cultureId": 0,
73        "value": "string"
74      }
75    ]
76  }
77}

Responses

Status

Meaning

Description

Schema

201

Created

Created

integer

Example Responses

10

Get Project Geographic Definition By Project Id

HTTP Request

GET /api/project-geo-definitions/project/{projectId}

📋 Description: Retrieves geographic definitions associated with a specific project, enabling enhanced portfolio and asset analytics within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

projectId

path

integer(int64)

true

Unique identifier for the project

Responses

Status

Meaning

Description

Schema

200

OK

OK

ProjectGeographicDefinitionDto

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  "cityId": 0,
10  "area": "string",
11  "addressTrafficTypeId": 0,
12  "intersection": "string",
13  "shapeCoordinates": "string",
14  "city": {
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    "province": {
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      "country": {
33        "createdBy": "string",
34        "lastModifiedBy": "string",
35        "createdDate": "2019-08-24T14:15:22Z",
36        "lastModifiedDate": "2019-08-24T14:15:22Z",
37        "archived": true,
38        "externalId": "string",
39        "id": 0,
40        "name": "string",
41        "code": "string"
42      },
43      "code": "string",
44      "countryId": 0
45    },
46    "provinceId": 0
47  },
48  "projectId": 0,
49  "addressTrafficType": {
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    "priority": 0,
58    "internalId": 0,
59    "pickListCode": "string",
60    "pickListLabel": "string",
61    "label": "string",
62    "cultureId": 0,
63    "labelDtos": [
64      {
65        "createdBy": "string",
66        "lastModifiedBy": "string",
67        "createdDate": "2019-08-24T14:15:22Z",
68        "lastModifiedDate": "2019-08-24T14:15:22Z",
69        "archived": true,
70        "externalId": "string",
71        "id": 0,
72        "cultureId": 0,
73        "value": "string"
74      }
75    ]
76  }
77}