Notifications¶
Notifications - Create Notifications¶
HTTP Request
POST /api/notifications
📋 Description: Creates a new notification within the Nakisa Portfolio Management Suite, enabling users to receive timely updates related to portfolio, asset, and real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing notification details, including type, message, and associated portfolio or asset identifiers, to facilitate effective communication within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdDate": "2019-08-24T14:15:22Z",
4 "lastModifiedDate": "2019-08-24T14:15:22Z",
5 "id": 0,
6 "forUserId": "string",
7 "byUserId": "string",
8 "type": "string",
9 "service": "string",
10 "triggerEvent": "string",
11 "triggerEventParams": [
12 "string"
13 ],
14 "clickEvent": "string",
15 "clickEventParams": [
16 "string"
17 ],
18 "titleCode": "string",
19 "titleParams": [
20 "string"
21 ],
22 "descriptionCode": "string",
23 "descriptionParams": [
24 "string"
25 ],
26 "viewed": true,
27 "title": "string",
28 "description": "string"
29 }
30]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdDate": "2019-08-24T14:15:22Z",
4 "lastModifiedDate": "2019-08-24T14:15:22Z",
5 "id": 0,
6 "forUserId": "string",
7 "byUserId": "string",
8 "type": "string",
9 "service": "string",
10 "triggerEvent": "string",
11 "triggerEventParams": [
12 "string"
13 ],
14 "clickEvent": "string",
15 "clickEventParams": [
16 "string"
17 ],
18 "titleCode": "string",
19 "titleParams": [
20 "string"
21 ],
22 "descriptionCode": "string",
23 "descriptionParams": [
24 "string"
25 ],
26 "viewed": true,
27 "title": "string",
28 "description": "string"
29 }
30]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing notifications related to portfolio management activities, asset updates, and analytics insights within the Nakisa Portfolio Management Suite, specifically tailored for real estate property management.] |
|
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» forUserId |
string |
false |
none |
Unique identifier for the for user |
» byUserId |
string |
false |
none |
Unique identifier for the by user |
» type |
string |
false |
none |
Type of the resource |
» service |
string |
false |
none |
Represents the specific service associated with a portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite, facilitating targeted analytics and management. |
» triggerEvent |
string |
false |
none |
Specifies the event that triggers a notification within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property management. |
» triggerEventParams |
[string] |
false |
none |
List of triggerEventParams items |
» clickEvent |
string |
false |
none |
Represents the user interaction event related to portfolio assets within the Nakisa Portfolio Management Suite, enabling enhanced analytics and insights for real estate property management. |
» clickEventParams |
[string] |
false |
none |
List of clickEventParams items |
» titleCode |
string |
false |
none |
Code for the title |
» titleParams |
[string] |
false |
none |
List of titleParams items |
» descriptionCode |
string |
false |
none |
Code for the description |
» descriptionParams |
[string] |
false |
none |
List of descriptionParams items |
» viewed |
boolean |
false |
none |
Boolean flag indicating viewed status |
» title |
string |
false |
none |
Title of the resource |
» description |
string |
false |
none |
Description of the resource |
Notifications - Upload Image¶
HTTP Request
POST /api/images
📋 Description: Uploads new images associated with real estate properties within the Nakisa Portfolio Management Suite, enhancing asset visualization and analytics capabilities for portfolio management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
false |
Request body containing image data and associated metadata for portfolio assets within the Nakisa Portfolio Management Suite. |
» file |
body |
string(binary) |
true |
none |
» image |
body |
true |
Data transfer object representing an image associated with real estate properties within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics. |
|
»» createdDate |
body |
string(date-time) |
false |
Date of the created |
»» lastModifiedDate |
body |
string(date-time) |
false |
Date of the last modified |
»» id |
body |
integer(int64) |
false |
Unique identifier for the resource |
»» name |
body |
string |
false |
Name of the resource |
»» service |
body |
string |
false |
Specifies the type of service associated with the asset within the Nakisa Portfolio Management Suite, relevant for portfolio analysis and real estate property management. |
»» type |
body |
string |
false |
Type of the resource |
»» content |
body |
object |
false |
Object containing content details |
»»» binaryStream |
body |
object |
false |
none |
Body Parameters
1{
2 "file": "string",
3 "image": {
4 "content": {
5 "binaryStream": {}
6 },
7 "createdDate": "2019-08-24 14:15:22+00:00",
8 "id": 0,
9 "lastModifiedDate": "2019-08-24 14:15:22+00:00",
10 "name": "string",
11 "service": "string",
12 "type": "string"
13 }
14}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
None |
Notifications - Create Email Notifications¶
HTTP Request
POST /api/email-notifications
📋 Description: Creates and sends email notifications related to portfolio and asset updates within the Nakisa Portfolio Management Suite, enhancing communication and analytics for real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the email notification details, including recipient information and message content, relevant for portfolio and asset management within the Nakisa Portfolio Management Suite. |
Body Parameters
1[
2 {
3 "createdDate": "2019-08-24T14:15:22Z",
4 "lastModifiedDate": "2019-08-24T14:15:22Z",
5 "id": 0,
6 "forUserEmail": "string",
7 "byUserEmail": "string",
8 "service": "string",
9 "subjectCode": "string",
10 "subjectParams": [
11 "string"
12 ],
13 "langCode": "string",
14 "bodyCode": "string",
15 "bodyParams": [
16 "string"
17 ],
18 "templateName": "string",
19 "sent": true,
20 "title": "string",
21 "description": "string"
22 }
23]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
Inline |
Example Responses
1[
2 {
3 "createdDate": "2019-08-24T14:15:22Z",
4 "lastModifiedDate": "2019-08-24T14:15:22Z",
5 "id": 0,
6 "forUserEmail": "string",
7 "byUserEmail": "string",
8 "service": "string",
9 "subjectCode": "string",
10 "subjectParams": [
11 "string"
12 ],
13 "langCode": "string",
14 "bodyCode": "string",
15 "bodyParams": [
16 "string"
17 ],
18 "templateName": "string",
19 "sent": true,
20 "title": "string",
21 "description": "string"
22 }
23]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an email notification related to portfolio management activities, including asset updates and analytics for real estate properties.] |
|
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» forUserEmail |
string |
false |
none |
User information related to portfolio management |
» byUserEmail |
string |
false |
none |
User information related to portfolio management |
» service |
string |
false |
none |
Specifies the type of service associated with the email notification, relevant to portfolio, asset, analytics, and real estate property management within the Nakisa Portfolio Management Suite. |
» subjectCode |
string |
false |
none |
Code for the subject |
» subjectParams |
[string] |
false |
none |
List of subjectParams items |
» langCode |
string |
false |
none |
Code for the lang |
» bodyCode |
string |
false |
none |
Code for the body |
» bodyParams |
[string] |
false |
none |
List of bodyParams items |
» templateName |
string |
false |
none |
Name of the template |
» sent |
boolean |
false |
none |
Boolean flag indicating sent status |
» title |
string |
false |
none |
Title of the resource |
» description |
string |
false |
none |
Description of the resource |
Notifications - Find Topics¶
HTTP Request
GET /api/topics/{service}
📋 Description: Fetches detailed information about specific topics related to portfolio management, asset analytics, and real estate properties, enabling users to gain insights and make informed decisions.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
service |
path |
string |
true |
Specifies the service type related to portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "createdDate": "2019-08-24T14:15:22Z",
4 "lastModifiedDate": "2019-08-24T14:15:22Z",
5 "id": 0,
6 "code": "string",
7 "service": "string",
8 "captionValues": [
9 {
10 "createdDate": "2019-08-24T14:15:22Z",
11 "lastModifiedDate": "2019-08-24T14:15:22Z",
12 "id": 0,
13 "langCode": "string",
14 "value": "string"
15 }
16 ]
17 }
18]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a specific topic within the Nakisa Portfolio Management Suite, encompassing key insights and analytics related to portfolio assets and real estate properties.] |
|
» createdDate |
string(date-time) |
false |
none |
Date of the created |
» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» code |
string |
false |
none |
Code identifier for the resource |
» service |
string |
false |
none |
Represents the specific service associated with a portfolio asset within the Nakisa Portfolio Management Suite, facilitating analytics and management of real estate properties. |
» captionValues |
false |
none |
List of captionValues items |
|
»» createdDate |
string(date-time) |
false |
none |
Date of the created |
»» lastModifiedDate |
string(date-time) |
false |
none |
Date of the last modified |
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» langCode |
string |
false |
none |
Code for the lang |
»» value |
string |
false |
none |
Represents the descriptive value associated with a portfolio asset, providing essential insights for analytics within the Nakisa Portfolio Management Suite. |
Notifications - Delete Image¶
HTTP Request
DELETE /api/images/{id}
📋 Description: Deletes a specified image from the Nakisa Portfolio Management Suite, streamlining asset management and enhancing portfolio 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 |
|---|---|---|---|
204 |
No Content |
None |
Notifications - Delete Email Notification¶
HTTP Request
DELETE /api/email-notifications/{id}
📋 Description: Deletes a specified email notification from the Nakisa Portfolio Management Suite, ensuring streamlined communication management within portfolio and asset 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 |
|---|---|---|---|
204 |
No Content |
None |