Event

Event - Update Event

HTTP Request

PUT /api/events/{id}

📋 Description: Updates the details of a specific event within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets and enhance analytics related to real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

EventDto

true

Request body containing updated event details, including attributes related to portfolio management, asset allocation, and 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  "typeId": 0,
 10  "code": "string",
 11  "reviewedBy": "string",
 12  "reviewedDate": "2019-08-24",
 13  "reviewedStatusId": 0,
 14  "activityDate": "2019-08-24",
 15  "relatedPickListOptionId": 0,
 16  "detail": "string",
 17  "note": {
 18    "createdBy": "string",
 19    "lastModifiedBy": "string",
 20    "createdDate": "2019-08-24T14:15:22Z",
 21    "lastModifiedDate": "2019-08-24T14:15:22Z",
 22    "archived": true,
 23    "externalId": "string",
 24    "id": 0,
 25    "message": "string",
 26    "preserveOriginalAudit": true,
 27    "originalCreatedBy": "string",
 28    "originalCreatedDate": "2019-08-24T14:15:22Z",
 29    "originalLastModifiedBy": "string",
 30    "originalLastModifiedDate": "2019-08-24T14:15:22Z"
 31  },
 32  "type": {
 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    "priority": 0,
 41    "internalId": 0,
 42    "pickListCode": "string",
 43    "pickListLabel": "string",
 44    "label": "string",
 45    "cultureId": 0,
 46    "labelDtos": [
 47      {
 48        "createdBy": "string",
 49        "lastModifiedBy": "string",
 50        "createdDate": "2019-08-24T14:15:22Z",
 51        "lastModifiedDate": "2019-08-24T14:15:22Z",
 52        "archived": true,
 53        "externalId": "string",
 54        "id": 0,
 55        "cultureId": 0,
 56        "value": "string"
 57      }
 58    ]
 59  },
 60  "reviewedStatus": {
 61    "createdBy": "string",
 62    "lastModifiedBy": "string",
 63    "createdDate": "2019-08-24T14:15:22Z",
 64    "lastModifiedDate": "2019-08-24T14:15:22Z",
 65    "archived": true,
 66    "externalId": "string",
 67    "id": 0,
 68    "priority": 0,
 69    "internalId": 0,
 70    "pickListCode": "string",
 71    "pickListLabel": "string",
 72    "label": "string",
 73    "cultureId": 0,
 74    "labelDtos": [
 75      {
 76        "createdBy": "string",
 77        "lastModifiedBy": "string",
 78        "createdDate": "2019-08-24T14:15:22Z",
 79        "lastModifiedDate": "2019-08-24T14:15:22Z",
 80        "archived": true,
 81        "externalId": "string",
 82        "id": 0,
 83        "cultureId": 0,
 84        "value": "string"
 85      }
 86    ]
 87  },
 88  "relatedPickListOption": {
 89    "createdBy": "string",
 90    "lastModifiedBy": "string",
 91    "createdDate": "2019-08-24T14:15:22Z",
 92    "lastModifiedDate": "2019-08-24T14:15:22Z",
 93    "archived": true,
 94    "externalId": "string",
 95    "id": 0,
 96    "priority": 0,
 97    "internalId": 0,
 98    "pickListCode": "string",
 99    "pickListLabel": "string",
100    "label": "string",
101    "cultureId": 0,
102    "labelDtos": [
103      {
104        "createdBy": "string",
105        "lastModifiedBy": "string",
106        "createdDate": "2019-08-24T14:15:22Z",
107        "lastModifiedDate": "2019-08-24T14:15:22Z",
108        "archived": true,
109        "externalId": "string",
110        "id": 0,
111        "cultureId": 0,
112        "value": "string"
113      }
114    ]
115  },
116  "isVisiblePartnerPortal": true
117}

Responses

Status

Meaning

Description

Schema

200

OK

OK

EventDto

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  "typeId": 0,
 10  "code": "string",
 11  "reviewedBy": "string",
 12  "reviewedDate": "2019-08-24",
 13  "reviewedStatusId": 0,
 14  "activityDate": "2019-08-24",
 15  "relatedPickListOptionId": 0,
 16  "detail": "string",
 17  "note": {
 18    "createdBy": "string",
 19    "lastModifiedBy": "string",
 20    "createdDate": "2019-08-24T14:15:22Z",
 21    "lastModifiedDate": "2019-08-24T14:15:22Z",
 22    "archived": true,
 23    "externalId": "string",
 24    "id": 0,
 25    "message": "string",
 26    "preserveOriginalAudit": true,
 27    "originalCreatedBy": "string",
 28    "originalCreatedDate": "2019-08-24T14:15:22Z",
 29    "originalLastModifiedBy": "string",
 30    "originalLastModifiedDate": "2019-08-24T14:15:22Z"
 31  },
 32  "type": {
 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    "priority": 0,
 41    "internalId": 0,
 42    "pickListCode": "string",
 43    "pickListLabel": "string",
 44    "label": "string",
 45    "cultureId": 0,
 46    "labelDtos": [
 47      {
 48        "createdBy": "string",
 49        "lastModifiedBy": "string",
 50        "createdDate": "2019-08-24T14:15:22Z",
 51        "lastModifiedDate": "2019-08-24T14:15:22Z",
 52        "archived": true,
 53        "externalId": "string",
 54        "id": 0,
 55        "cultureId": 0,
 56        "value": "string"
 57      }
 58    ]
 59  },
 60  "reviewedStatus": {
 61    "createdBy": "string",
 62    "lastModifiedBy": "string",
 63    "createdDate": "2019-08-24T14:15:22Z",
 64    "lastModifiedDate": "2019-08-24T14:15:22Z",
 65    "archived": true,
 66    "externalId": "string",
 67    "id": 0,
 68    "priority": 0,
 69    "internalId": 0,
 70    "pickListCode": "string",
 71    "pickListLabel": "string",
 72    "label": "string",
 73    "cultureId": 0,
 74    "labelDtos": [
 75      {
 76        "createdBy": "string",
 77        "lastModifiedBy": "string",
 78        "createdDate": "2019-08-24T14:15:22Z",
 79        "lastModifiedDate": "2019-08-24T14:15:22Z",
 80        "archived": true,
 81        "externalId": "string",
 82        "id": 0,
 83        "cultureId": 0,
 84        "value": "string"
 85      }
 86    ]
 87  },
 88  "relatedPickListOption": {
 89    "createdBy": "string",
 90    "lastModifiedBy": "string",
 91    "createdDate": "2019-08-24T14:15:22Z",
 92    "lastModifiedDate": "2019-08-24T14:15:22Z",
 93    "archived": true,
 94    "externalId": "string",
 95    "id": 0,
 96    "priority": 0,
 97    "internalId": 0,
 98    "pickListCode": "string",
 99    "pickListLabel": "string",
100    "label": "string",
101    "cultureId": 0,
102    "labelDtos": [
103      {
104        "createdBy": "string",
105        "lastModifiedBy": "string",
106        "createdDate": "2019-08-24T14:15:22Z",
107        "lastModifiedDate": "2019-08-24T14:15:22Z",
108        "archived": true,
109        "externalId": "string",
110        "id": 0,
111        "cultureId": 0,
112        "value": "string"
113      }
114    ]
115  },
116  "isVisiblePartnerPortal": true
117}

Event - Delete Event

HTTP Request

DELETE /api/events/{id}

📋 Description: Deletes a specified event from the Nakisa Portfolio Management Suite, facilitating the management of portfolios, assets, and 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

200

OK

OK

None

Event - Reject Event

HTTP Request

POST /api/events/{id}/reject

📋 Description: Rejects a specified event within the Nakisa Portfolio Management Suite, allowing users to manage portfolio-related activities effectively in the context of asset and real estate property analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

NoteDto

true

Request body containing the rejection rationale and any relevant metadata for the specified event 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  "message": "string",
10  "userIds": [
11    0
12  ],
13  "redirectUrl": "string"
14}

Responses

Status

Meaning

Description

Schema

200

OK

OK

EventDto

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  "typeId": 0,
 10  "code": "string",
 11  "reviewedBy": "string",
 12  "reviewedDate": "2019-08-24",
 13  "reviewedStatusId": 0,
 14  "activityDate": "2019-08-24",
 15  "relatedPickListOptionId": 0,
 16  "detail": "string",
 17  "note": {
 18    "createdBy": "string",
 19    "lastModifiedBy": "string",
 20    "createdDate": "2019-08-24T14:15:22Z",
 21    "lastModifiedDate": "2019-08-24T14:15:22Z",
 22    "archived": true,
 23    "externalId": "string",
 24    "id": 0,
 25    "message": "string",
 26    "preserveOriginalAudit": true,
 27    "originalCreatedBy": "string",
 28    "originalCreatedDate": "2019-08-24T14:15:22Z",
 29    "originalLastModifiedBy": "string",
 30    "originalLastModifiedDate": "2019-08-24T14:15:22Z"
 31  },
 32  "type": {
 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    "priority": 0,
 41    "internalId": 0,
 42    "pickListCode": "string",
 43    "pickListLabel": "string",
 44    "label": "string",
 45    "cultureId": 0,
 46    "labelDtos": [
 47      {
 48        "createdBy": "string",
 49        "lastModifiedBy": "string",
 50        "createdDate": "2019-08-24T14:15:22Z",
 51        "lastModifiedDate": "2019-08-24T14:15:22Z",
 52        "archived": true,
 53        "externalId": "string",
 54        "id": 0,
 55        "cultureId": 0,
 56        "value": "string"
 57      }
 58    ]
 59  },
 60  "reviewedStatus": {
 61    "createdBy": "string",
 62    "lastModifiedBy": "string",
 63    "createdDate": "2019-08-24T14:15:22Z",
 64    "lastModifiedDate": "2019-08-24T14:15:22Z",
 65    "archived": true,
 66    "externalId": "string",
 67    "id": 0,
 68    "priority": 0,
 69    "internalId": 0,
 70    "pickListCode": "string",
 71    "pickListLabel": "string",
 72    "label": "string",
 73    "cultureId": 0,
 74    "labelDtos": [
 75      {
 76        "createdBy": "string",
 77        "lastModifiedBy": "string",
 78        "createdDate": "2019-08-24T14:15:22Z",
 79        "lastModifiedDate": "2019-08-24T14:15:22Z",
 80        "archived": true,
 81        "externalId": "string",
 82        "id": 0,
 83        "cultureId": 0,
 84        "value": "string"
 85      }
 86    ]
 87  },
 88  "relatedPickListOption": {
 89    "createdBy": "string",
 90    "lastModifiedBy": "string",
 91    "createdDate": "2019-08-24T14:15:22Z",
 92    "lastModifiedDate": "2019-08-24T14:15:22Z",
 93    "archived": true,
 94    "externalId": "string",
 95    "id": 0,
 96    "priority": 0,
 97    "internalId": 0,
 98    "pickListCode": "string",
 99    "pickListLabel": "string",
100    "label": "string",
101    "cultureId": 0,
102    "labelDtos": [
103      {
104        "createdBy": "string",
105        "lastModifiedBy": "string",
106        "createdDate": "2019-08-24T14:15:22Z",
107        "lastModifiedDate": "2019-08-24T14:15:22Z",
108        "archived": true,
109        "externalId": "string",
110        "id": 0,
111        "cultureId": 0,
112        "value": "string"
113      }
114    ]
115  },
116  "isVisiblePartnerPortal": true
117}

Event - Approve Event

HTTP Request

POST /api/events/{id}/approve

📋 Description: Approves a specified event within the Nakisa Portfolio Management Suite, facilitating timely decision-making in portfolio and asset management for enhanced analytics and real estate property oversight.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

NoteDto

true

Request body containing the approval details for the specified event, including relevant metadata and status updates related to portfolio and asset management.

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  "message": "string",
10  "userIds": [
11    0
12  ],
13  "redirectUrl": "string"
14}

Responses

Status

Meaning

Description

Schema

200

OK

OK

EventDto

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  "typeId": 0,
 10  "code": "string",
 11  "reviewedBy": "string",
 12  "reviewedDate": "2019-08-24",
 13  "reviewedStatusId": 0,
 14  "activityDate": "2019-08-24",
 15  "relatedPickListOptionId": 0,
 16  "detail": "string",
 17  "note": {
 18    "createdBy": "string",
 19    "lastModifiedBy": "string",
 20    "createdDate": "2019-08-24T14:15:22Z",
 21    "lastModifiedDate": "2019-08-24T14:15:22Z",
 22    "archived": true,
 23    "externalId": "string",
 24    "id": 0,
 25    "message": "string",
 26    "preserveOriginalAudit": true,
 27    "originalCreatedBy": "string",
 28    "originalCreatedDate": "2019-08-24T14:15:22Z",
 29    "originalLastModifiedBy": "string",
 30    "originalLastModifiedDate": "2019-08-24T14:15:22Z"
 31  },
 32  "type": {
 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    "priority": 0,
 41    "internalId": 0,
 42    "pickListCode": "string",
 43    "pickListLabel": "string",
 44    "label": "string",
 45    "cultureId": 0,
 46    "labelDtos": [
 47      {
 48        "createdBy": "string",
 49        "lastModifiedBy": "string",
 50        "createdDate": "2019-08-24T14:15:22Z",
 51        "lastModifiedDate": "2019-08-24T14:15:22Z",
 52        "archived": true,
 53        "externalId": "string",
 54        "id": 0,
 55        "cultureId": 0,
 56        "value": "string"
 57      }
 58    ]
 59  },
 60  "reviewedStatus": {
 61    "createdBy": "string",
 62    "lastModifiedBy": "string",
 63    "createdDate": "2019-08-24T14:15:22Z",
 64    "lastModifiedDate": "2019-08-24T14:15:22Z",
 65    "archived": true,
 66    "externalId": "string",
 67    "id": 0,
 68    "priority": 0,
 69    "internalId": 0,
 70    "pickListCode": "string",
 71    "pickListLabel": "string",
 72    "label": "string",
 73    "cultureId": 0,
 74    "labelDtos": [
 75      {
 76        "createdBy": "string",
 77        "lastModifiedBy": "string",
 78        "createdDate": "2019-08-24T14:15:22Z",
 79        "lastModifiedDate": "2019-08-24T14:15:22Z",
 80        "archived": true,
 81        "externalId": "string",
 82        "id": 0,
 83        "cultureId": 0,
 84        "value": "string"
 85      }
 86    ]
 87  },
 88  "relatedPickListOption": {
 89    "createdBy": "string",
 90    "lastModifiedBy": "string",
 91    "createdDate": "2019-08-24T14:15:22Z",
 92    "lastModifiedDate": "2019-08-24T14:15:22Z",
 93    "archived": true,
 94    "externalId": "string",
 95    "id": 0,
 96    "priority": 0,
 97    "internalId": 0,
 98    "pickListCode": "string",
 99    "pickListLabel": "string",
100    "label": "string",
101    "cultureId": 0,
102    "labelDtos": [
103      {
104        "createdBy": "string",
105        "lastModifiedBy": "string",
106        "createdDate": "2019-08-24T14:15:22Z",
107        "lastModifiedDate": "2019-08-24T14:15:22Z",
108        "archived": true,
109        "externalId": "string",
110        "id": 0,
111        "cultureId": 0,
112        "value": "string"
113      }
114    ]
115  },
116  "isVisiblePartnerPortal": true
117}