Unsubscribed Topic¶
Unsubscribed Topic - Get Unsubscribed Topics¶
HTTP Request
GET /api/unsubscribed-topics
📋 Description: Retrieves a list of topics that users have unsubscribed from within the Nakisa Portfolio Management Suite, enabling enhanced asset and portfolio analytics for real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of unsubscribed topics should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite for portfolio and asset analytics. |
|
topic-code |
query |
string |
false |
Identifier for the specific topic within the portfolio management suite that the user wishes to unsubscribe from, facilitating targeted asset and analytics management in real estate properties. |
user-id |
query |
string |
false |
Unique identifier for the user, utilized to retrieve a list of topics the user has unsubscribed from within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "unsubscribedTopics": [
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 "userId": 0,
13 "topicCode": "string"
14 }
15 ]
16 },
17 "page": {
18 "size": 0,
19 "totalElements": 0,
20 "totalPages": 0,
21 "number": 0
22 }
23}
Unsubscribed Topic - Create Unsubscribed Topics¶
HTTP Request
POST /api/unsubscribed-topics
📋 Description: Submits a request to unsubscribe from specified topics within the Nakisa Portfolio Management Suite, enabling users to streamline their portfolio and asset analytics related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a list of topics to be unsubscribed from, relevant to portfolio and asset management 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 "userId": 0,
11 "topicCode": "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 "userId": 0,
11 "topicCode": "string"
12 }
13]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a topic that a user has unsubscribed from within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics in the context of real estate property management.] |
|
» 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 |
» userId |
integer(int64) |
true |
none |
Unique identifier for the user |
» topicCode |
string |
true |
none |
Code for the topic |
Unsubscribed Topic - Get User Unsubscribed Topics¶
HTTP Request
GET /api/unsubscribed-topics/{userId}
📋 Description: Retrieves a list of topics that the specified user has unsubscribed from within the Nakisa Portfolio Management Suite, facilitating enhanced asset and portfolio analytics related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userId |
path |
integer(int64) |
true |
Unique identifier for the user |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "userId": 0,
11 "topicCode": "string"
12 }
13]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a topic that a user has unsubscribed from within the Nakisa Portfolio Management Suite, facilitating portfolio and asset analytics in the context of real estate property management.] |
|
» 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 |
» userId |
integer(int64) |
true |
none |
Unique identifier for the user |
» topicCode |
string |
true |
none |
Code for the topic |
Unsubscribed Topic - Delete Unsubscribed Topic¶
HTTP Request
DELETE /api/unsubscribed-topics/{id}
📋 Description: Deletes a specified unsubscribed topic from the Nakisa Portfolio Management Suite, enabling users to manage their portfolio preferences effectively within 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 |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |