Reminder

Reminder - Get Reminder

HTTP Request

GET /api/reminders/{id}

📋 Description: Fetches the details of a specific reminder associated with a portfolio asset, enabling users to access important notifications 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

ReminderDto

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  "subjectId": 0,
 10  "categoryId": 0,
 11  "statusId": 0,
 12  "reminderTypeId": 0,
 13  "date": "2019-08-24",
 14  "followUpDate": "2019-08-24",
 15  "comments": "string",
 16  "primaryUserId": 0,
 17  "subject": {
 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    "priority": 0,
 26    "internalId": 0,
 27    "pickListCode": "string",
 28    "pickListLabel": "string",
 29    "label": "string",
 30    "cultureId": 0,
 31    "labelDtos": [
 32      {
 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        "cultureId": 0,
 41        "value": "string"
 42      }
 43    ]
 44  },
 45  "category": {
 46    "createdBy": "string",
 47    "lastModifiedBy": "string",
 48    "createdDate": "2019-08-24T14:15:22Z",
 49    "lastModifiedDate": "2019-08-24T14:15:22Z",
 50    "archived": true,
 51    "externalId": "string",
 52    "id": 0,
 53    "priority": 0,
 54    "internalId": 0,
 55    "pickListCode": "string",
 56    "pickListLabel": "string",
 57    "label": "string",
 58    "cultureId": 0,
 59    "labelDtos": [
 60      {
 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        "cultureId": 0,
 69        "value": "string"
 70      }
 71    ]
 72  },
 73  "status": {
 74    "createdBy": "string",
 75    "lastModifiedBy": "string",
 76    "createdDate": "2019-08-24T14:15:22Z",
 77    "lastModifiedDate": "2019-08-24T14:15:22Z",
 78    "archived": true,
 79    "externalId": "string",
 80    "id": 0,
 81    "priority": 0,
 82    "internalId": 0,
 83    "pickListCode": "string",
 84    "pickListLabel": "string",
 85    "label": "string",
 86    "cultureId": 0,
 87    "labelDtos": [
 88      {
 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        "cultureId": 0,
 97        "value": "string"
 98      }
 99    ]
100  },
101  "reminderType": {
102    "createdBy": "string",
103    "lastModifiedBy": "string",
104    "createdDate": "2019-08-24T14:15:22Z",
105    "lastModifiedDate": "2019-08-24T14:15:22Z",
106    "archived": true,
107    "externalId": "string",
108    "id": 0,
109    "priority": 0,
110    "internalId": 0,
111    "pickListCode": "string",
112    "pickListLabel": "string",
113    "label": "string",
114    "cultureId": 0,
115    "labelDtos": [
116      {
117        "createdBy": "string",
118        "lastModifiedBy": "string",
119        "createdDate": "2019-08-24T14:15:22Z",
120        "lastModifiedDate": "2019-08-24T14:15:22Z",
121        "archived": true,
122        "externalId": "string",
123        "id": 0,
124        "cultureId": 0,
125        "value": "string"
126      }
127    ]
128  },
129  "primaryUser": {
130    "createdBy": "string",
131    "lastModifiedBy": "string",
132    "createdDate": "2019-08-24T14:15:22Z",
133    "lastModifiedDate": "2019-08-24T14:15:22Z",
134    "archived": true,
135    "externalId": "string",
136    "id": 0,
137    "email": "string",
138    "userName": "string",
139    "firstName": "string",
140    "lastName": "string",
141    "displayName": "string",
142    "permissions": "string",
143    "internalId": "string",
144    "preferredCulture": {
145      "createdBy": "string",
146      "lastModifiedBy": "string",
147      "createdDate": "2019-08-24T14:15:22Z",
148      "lastModifiedDate": "2019-08-24T14:15:22Z",
149      "archived": true,
150      "externalId": "string",
151      "id": 0,
152      "name": "string",
153      "code": "string",
154      "defaultCulture": true,
155      "enable": true
156    },
157    "userGroups": [
158      {
159        "createdBy": "string",
160        "lastModifiedBy": "string",
161        "createdDate": "2019-08-24T14:15:22Z",
162        "lastModifiedDate": "2019-08-24T14:15:22Z",
163        "archived": true,
164        "externalId": "string",
165        "id": 0,
166        "name": "string",
167        "description": "string",
168        "internalId": "string"
169      }
170    ],
171    "partnerIds": [
172      0
173    ],
174    "partners": [
175      {
176        "id": 0,
177        "status": "CREATED",
178        "displayId": "string",
179        "erpSystemId": 0,
180        "erpSystemDisplayId": "string",
181        "name": "string",
182        "fax": "string",
183        "phone": "string",
184        "parentId": 0,
185        "parentName": "string",
186        "parentDisplayId": "string",
187        "companyId": 0,
188        "partnerRoleId": 0,
189        "partnerContactId": 0
190      }
191    ]
192  },
193  "leaseExternalId": "string",
194  "premiseName": "string",
195  "reminderUserDtos": [
196    {
197      "createdBy": "string",
198      "lastModifiedBy": "string",
199      "createdDate": "2019-08-24T14:15:22Z",
200      "lastModifiedDate": "2019-08-24T14:15:22Z",
201      "archived": true,
202      "externalId": "string",
203      "acknowledge": true,
204      "userDto": {
205        "createdBy": "string",
206        "lastModifiedBy": "string",
207        "createdDate": "2019-08-24T14:15:22Z",
208        "lastModifiedDate": "2019-08-24T14:15:22Z",
209        "archived": true,
210        "externalId": "string",
211        "id": 0,
212        "email": "string",
213        "userName": "string",
214        "firstName": "string",
215        "lastName": "string",
216        "displayName": "string",
217        "permissions": "string",
218        "internalId": "string",
219        "preferredCulture": {
220          "createdBy": "string",
221          "lastModifiedBy": "string",
222          "createdDate": "2019-08-24T14:15:22Z",
223          "lastModifiedDate": "2019-08-24T14:15:22Z",
224          "archived": true,
225          "externalId": "string",
226          "id": 0,
227          "name": "string",
228          "code": "string",
229          "defaultCulture": true,
230          "enable": true
231        },
232        "userGroups": [
233          {
234            "createdBy": "string",
235            "lastModifiedBy": "string",
236            "createdDate": "2019-08-24T14:15:22Z",
237            "lastModifiedDate": "2019-08-24T14:15:22Z",
238            "archived": true,
239            "externalId": "string",
240            "id": 0,
241            "name": "string",
242            "description": "string",
243            "internalId": "string"
244          }
245        ],
246        "partnerIds": [
247          0
248        ],
249        "partners": [
250          {
251            "id": 0,
252            "status": "CREATED",
253            "displayId": "string",
254            "erpSystemId": 0,
255            "erpSystemDisplayId": "string",
256            "name": "string",
257            "fax": "string",
258            "phone": "string",
259            "parentId": 0,
260            "parentName": "string",
261            "parentDisplayId": "string",
262            "companyId": 0,
263            "partnerRoleId": 0,
264            "partnerContactId": 0
265          }
266        ]
267      }
268    }
269  ]
270}

Reminder - Update Reminder

HTTP Request

PUT /api/reminders/{id}

📋 Description: Updates the details of a specific reminder identified by its unique ID within the Nakisa Portfolio Management Suite, enabling users to manage portfolio-related notifications effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ReminderDto

true

Request body containing the updated reminder details, including title, description, due date, and associated portfolio or asset identifiers, to facilitate effective management of real estate property reminders.

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  "subjectId": 0,
 10  "categoryId": 0,
 11  "statusId": 0,
 12  "reminderTypeId": 0,
 13  "date": "2019-08-24",
 14  "followUpDate": "2019-08-24",
 15  "comments": "string",
 16  "primaryUserId": 0,
 17  "subject": {
 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    "priority": 0,
 26    "internalId": 0,
 27    "pickListCode": "string",
 28    "pickListLabel": "string",
 29    "label": "string",
 30    "cultureId": 0,
 31    "labelDtos": [
 32      {
 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        "cultureId": 0,
 41        "value": "string"
 42      }
 43    ]
 44  },
 45  "category": {
 46    "createdBy": "string",
 47    "lastModifiedBy": "string",
 48    "createdDate": "2019-08-24T14:15:22Z",
 49    "lastModifiedDate": "2019-08-24T14:15:22Z",
 50    "archived": true,
 51    "externalId": "string",
 52    "id": 0,
 53    "priority": 0,
 54    "internalId": 0,
 55    "pickListCode": "string",
 56    "pickListLabel": "string",
 57    "label": "string",
 58    "cultureId": 0,
 59    "labelDtos": [
 60      {
 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        "cultureId": 0,
 69        "value": "string"
 70      }
 71    ]
 72  },
 73  "status": {
 74    "createdBy": "string",
 75    "lastModifiedBy": "string",
 76    "createdDate": "2019-08-24T14:15:22Z",
 77    "lastModifiedDate": "2019-08-24T14:15:22Z",
 78    "archived": true,
 79    "externalId": "string",
 80    "id": 0,
 81    "priority": 0,
 82    "internalId": 0,
 83    "pickListCode": "string",
 84    "pickListLabel": "string",
 85    "label": "string",
 86    "cultureId": 0,
 87    "labelDtos": [
 88      {
 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        "cultureId": 0,
 97        "value": "string"
 98      }
 99    ]
100  },
101  "reminderType": {
102    "createdBy": "string",
103    "lastModifiedBy": "string",
104    "createdDate": "2019-08-24T14:15:22Z",
105    "lastModifiedDate": "2019-08-24T14:15:22Z",
106    "archived": true,
107    "externalId": "string",
108    "id": 0,
109    "priority": 0,
110    "internalId": 0,
111    "pickListCode": "string",
112    "pickListLabel": "string",
113    "label": "string",
114    "cultureId": 0,
115    "labelDtos": [
116      {
117        "createdBy": "string",
118        "lastModifiedBy": "string",
119        "createdDate": "2019-08-24T14:15:22Z",
120        "lastModifiedDate": "2019-08-24T14:15:22Z",
121        "archived": true,
122        "externalId": "string",
123        "id": 0,
124        "cultureId": 0,
125        "value": "string"
126      }
127    ]
128  },
129  "primaryUser": {
130    "createdBy": "string",
131    "lastModifiedBy": "string",
132    "createdDate": "2019-08-24T14:15:22Z",
133    "lastModifiedDate": "2019-08-24T14:15:22Z",
134    "archived": true,
135    "externalId": "string",
136    "id": 0,
137    "email": "string",
138    "userName": "string",
139    "firstName": "string",
140    "lastName": "string",
141    "displayName": "string",
142    "permissions": "string",
143    "internalId": "string",
144    "preferredCulture": {
145      "createdBy": "string",
146      "lastModifiedBy": "string",
147      "createdDate": "2019-08-24T14:15:22Z",
148      "lastModifiedDate": "2019-08-24T14:15:22Z",
149      "archived": true,
150      "externalId": "string",
151      "id": 0,
152      "name": "string",
153      "code": "string",
154      "defaultCulture": true,
155      "enable": true
156    },
157    "userGroups": [
158      {
159        "createdBy": "string",
160        "lastModifiedBy": "string",
161        "createdDate": "2019-08-24T14:15:22Z",
162        "lastModifiedDate": "2019-08-24T14:15:22Z",
163        "archived": true,
164        "externalId": "string",
165        "id": 0,
166        "name": "string",
167        "description": "string",
168        "internalId": "string"
169      }
170    ],
171    "partnerIds": [
172      0
173    ],
174    "partners": [
175      {
176        "id": 0,
177        "status": "CREATED",
178        "displayId": "string",
179        "erpSystemId": 0,
180        "erpSystemDisplayId": "string",
181        "name": "string",
182        "fax": "string",
183        "phone": "string",
184        "parentId": 0,
185        "parentName": "string",
186        "parentDisplayId": "string",
187        "companyId": 0,
188        "partnerRoleId": 0,
189        "partnerContactId": 0
190      }
191    ]
192  },
193  "leaseExternalId": "string",
194  "premiseName": "string",
195  "reminderUserDtos": [
196    {
197      "createdBy": "string",
198      "lastModifiedBy": "string",
199      "createdDate": "2019-08-24T14:15:22Z",
200      "lastModifiedDate": "2019-08-24T14:15:22Z",
201      "archived": true,
202      "externalId": "string",
203      "acknowledge": true,
204      "userDto": {
205        "createdBy": "string",
206        "lastModifiedBy": "string",
207        "createdDate": "2019-08-24T14:15:22Z",
208        "lastModifiedDate": "2019-08-24T14:15:22Z",
209        "archived": true,
210        "externalId": "string",
211        "id": 0,
212        "email": "string",
213        "userName": "string",
214        "firstName": "string",
215        "lastName": "string",
216        "displayName": "string",
217        "permissions": "string",
218        "internalId": "string",
219        "preferredCulture": {
220          "createdBy": "string",
221          "lastModifiedBy": "string",
222          "createdDate": "2019-08-24T14:15:22Z",
223          "lastModifiedDate": "2019-08-24T14:15:22Z",
224          "archived": true,
225          "externalId": "string",
226          "id": 0,
227          "name": "string",
228          "code": "string",
229          "defaultCulture": true,
230          "enable": true
231        },
232        "userGroups": [
233          {
234            "createdBy": "string",
235            "lastModifiedBy": "string",
236            "createdDate": "2019-08-24T14:15:22Z",
237            "lastModifiedDate": "2019-08-24T14:15:22Z",
238            "archived": true,
239            "externalId": "string",
240            "id": 0,
241            "name": "string",
242            "description": "string",
243            "internalId": "string"
244          }
245        ],
246        "partnerIds": [
247          0
248        ],
249        "partners": [
250          {
251            "id": 0,
252            "status": "CREATED",
253            "displayId": "string",
254            "erpSystemId": 0,
255            "erpSystemDisplayId": "string",
256            "name": "string",
257            "fax": "string",
258            "phone": "string",
259            "parentId": 0,
260            "parentName": "string",
261            "parentDisplayId": "string",
262            "companyId": 0,
263            "partnerRoleId": 0,
264            "partnerContactId": 0
265          }
266        ]
267      }
268    }
269  ]
270}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ReminderDto

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  "subjectId": 0,
 10  "categoryId": 0,
 11  "statusId": 0,
 12  "reminderTypeId": 0,
 13  "date": "2019-08-24",
 14  "followUpDate": "2019-08-24",
 15  "comments": "string",
 16  "primaryUserId": 0,
 17  "subject": {
 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    "priority": 0,
 26    "internalId": 0,
 27    "pickListCode": "string",
 28    "pickListLabel": "string",
 29    "label": "string",
 30    "cultureId": 0,
 31    "labelDtos": [
 32      {
 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        "cultureId": 0,
 41        "value": "string"
 42      }
 43    ]
 44  },
 45  "category": {
 46    "createdBy": "string",
 47    "lastModifiedBy": "string",
 48    "createdDate": "2019-08-24T14:15:22Z",
 49    "lastModifiedDate": "2019-08-24T14:15:22Z",
 50    "archived": true,
 51    "externalId": "string",
 52    "id": 0,
 53    "priority": 0,
 54    "internalId": 0,
 55    "pickListCode": "string",
 56    "pickListLabel": "string",
 57    "label": "string",
 58    "cultureId": 0,
 59    "labelDtos": [
 60      {
 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        "cultureId": 0,
 69        "value": "string"
 70      }
 71    ]
 72  },
 73  "status": {
 74    "createdBy": "string",
 75    "lastModifiedBy": "string",
 76    "createdDate": "2019-08-24T14:15:22Z",
 77    "lastModifiedDate": "2019-08-24T14:15:22Z",
 78    "archived": true,
 79    "externalId": "string",
 80    "id": 0,
 81    "priority": 0,
 82    "internalId": 0,
 83    "pickListCode": "string",
 84    "pickListLabel": "string",
 85    "label": "string",
 86    "cultureId": 0,
 87    "labelDtos": [
 88      {
 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        "cultureId": 0,
 97        "value": "string"
 98      }
 99    ]
100  },
101  "reminderType": {
102    "createdBy": "string",
103    "lastModifiedBy": "string",
104    "createdDate": "2019-08-24T14:15:22Z",
105    "lastModifiedDate": "2019-08-24T14:15:22Z",
106    "archived": true,
107    "externalId": "string",
108    "id": 0,
109    "priority": 0,
110    "internalId": 0,
111    "pickListCode": "string",
112    "pickListLabel": "string",
113    "label": "string",
114    "cultureId": 0,
115    "labelDtos": [
116      {
117        "createdBy": "string",
118        "lastModifiedBy": "string",
119        "createdDate": "2019-08-24T14:15:22Z",
120        "lastModifiedDate": "2019-08-24T14:15:22Z",
121        "archived": true,
122        "externalId": "string",
123        "id": 0,
124        "cultureId": 0,
125        "value": "string"
126      }
127    ]
128  },
129  "primaryUser": {
130    "createdBy": "string",
131    "lastModifiedBy": "string",
132    "createdDate": "2019-08-24T14:15:22Z",
133    "lastModifiedDate": "2019-08-24T14:15:22Z",
134    "archived": true,
135    "externalId": "string",
136    "id": 0,
137    "email": "string",
138    "userName": "string",
139    "firstName": "string",
140    "lastName": "string",
141    "displayName": "string",
142    "permissions": "string",
143    "internalId": "string",
144    "preferredCulture": {
145      "createdBy": "string",
146      "lastModifiedBy": "string",
147      "createdDate": "2019-08-24T14:15:22Z",
148      "lastModifiedDate": "2019-08-24T14:15:22Z",
149      "archived": true,
150      "externalId": "string",
151      "id": 0,
152      "name": "string",
153      "code": "string",
154      "defaultCulture": true,
155      "enable": true
156    },
157    "userGroups": [
158      {
159        "createdBy": "string",
160        "lastModifiedBy": "string",
161        "createdDate": "2019-08-24T14:15:22Z",
162        "lastModifiedDate": "2019-08-24T14:15:22Z",
163        "archived": true,
164        "externalId": "string",
165        "id": 0,
166        "name": "string",
167        "description": "string",
168        "internalId": "string"
169      }
170    ],
171    "partnerIds": [
172      0
173    ],
174    "partners": [
175      {
176        "id": 0,
177        "status": "CREATED",
178        "displayId": "string",
179        "erpSystemId": 0,
180        "erpSystemDisplayId": "string",
181        "name": "string",
182        "fax": "string",
183        "phone": "string",
184        "parentId": 0,
185        "parentName": "string",
186        "parentDisplayId": "string",
187        "companyId": 0,
188        "partnerRoleId": 0,
189        "partnerContactId": 0
190      }
191    ]
192  },
193  "leaseExternalId": "string",
194  "premiseName": "string",
195  "reminderUserDtos": [
196    {
197      "createdBy": "string",
198      "lastModifiedBy": "string",
199      "createdDate": "2019-08-24T14:15:22Z",
200      "lastModifiedDate": "2019-08-24T14:15:22Z",
201      "archived": true,
202      "externalId": "string",
203      "acknowledge": true,
204      "userDto": {
205        "createdBy": "string",
206        "lastModifiedBy": "string",
207        "createdDate": "2019-08-24T14:15:22Z",
208        "lastModifiedDate": "2019-08-24T14:15:22Z",
209        "archived": true,
210        "externalId": "string",
211        "id": 0,
212        "email": "string",
213        "userName": "string",
214        "firstName": "string",
215        "lastName": "string",
216        "displayName": "string",
217        "permissions": "string",
218        "internalId": "string",
219        "preferredCulture": {
220          "createdBy": "string",
221          "lastModifiedBy": "string",
222          "createdDate": "2019-08-24T14:15:22Z",
223          "lastModifiedDate": "2019-08-24T14:15:22Z",
224          "archived": true,
225          "externalId": "string",
226          "id": 0,
227          "name": "string",
228          "code": "string",
229          "defaultCulture": true,
230          "enable": true
231        },
232        "userGroups": [
233          {
234            "createdBy": "string",
235            "lastModifiedBy": "string",
236            "createdDate": "2019-08-24T14:15:22Z",
237            "lastModifiedDate": "2019-08-24T14:15:22Z",
238            "archived": true,
239            "externalId": "string",
240            "id": 0,
241            "name": "string",
242            "description": "string",
243            "internalId": "string"
244          }
245        ],
246        "partnerIds": [
247          0
248        ],
249        "partners": [
250          {
251            "id": 0,
252            "status": "CREATED",
253            "displayId": "string",
254            "erpSystemId": 0,
255            "erpSystemDisplayId": "string",
256            "name": "string",
257            "fax": "string",
258            "phone": "string",
259            "parentId": 0,
260            "parentName": "string",
261            "parentDisplayId": "string",
262            "companyId": 0,
263            "partnerRoleId": 0,
264            "partnerContactId": 0
265          }
266        ]
267      }
268    }
269  ]
270}

Reminder - Delete Reminder

HTTP Request

DELETE /api/reminders/{id}

📋 Description: Deletes a specified reminder from the Nakisa Portfolio Management Suite, enabling users to manage their portfolio and asset-related notifications effectively.

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

Reminder - Archive Reminder

HTTP Request

POST /api/reminders/{id}/archive

📋 Description: Archives a specified reminder within the Nakisa Portfolio Management Suite, facilitating streamlined 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

201

Created

Created

ReminderDto

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  "subjectId": 0,
 10  "categoryId": 0,
 11  "statusId": 0,
 12  "reminderTypeId": 0,
 13  "date": "2019-08-24",
 14  "followUpDate": "2019-08-24",
 15  "comments": "string",
 16  "primaryUserId": 0,
 17  "subject": {
 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    "priority": 0,
 26    "internalId": 0,
 27    "pickListCode": "string",
 28    "pickListLabel": "string",
 29    "label": "string",
 30    "cultureId": 0,
 31    "labelDtos": [
 32      {
 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        "cultureId": 0,
 41        "value": "string"
 42      }
 43    ]
 44  },
 45  "category": {
 46    "createdBy": "string",
 47    "lastModifiedBy": "string",
 48    "createdDate": "2019-08-24T14:15:22Z",
 49    "lastModifiedDate": "2019-08-24T14:15:22Z",
 50    "archived": true,
 51    "externalId": "string",
 52    "id": 0,
 53    "priority": 0,
 54    "internalId": 0,
 55    "pickListCode": "string",
 56    "pickListLabel": "string",
 57    "label": "string",
 58    "cultureId": 0,
 59    "labelDtos": [
 60      {
 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        "cultureId": 0,
 69        "value": "string"
 70      }
 71    ]
 72  },
 73  "status": {
 74    "createdBy": "string",
 75    "lastModifiedBy": "string",
 76    "createdDate": "2019-08-24T14:15:22Z",
 77    "lastModifiedDate": "2019-08-24T14:15:22Z",
 78    "archived": true,
 79    "externalId": "string",
 80    "id": 0,
 81    "priority": 0,
 82    "internalId": 0,
 83    "pickListCode": "string",
 84    "pickListLabel": "string",
 85    "label": "string",
 86    "cultureId": 0,
 87    "labelDtos": [
 88      {
 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        "cultureId": 0,
 97        "value": "string"
 98      }
 99    ]
100  },
101  "reminderType": {
102    "createdBy": "string",
103    "lastModifiedBy": "string",
104    "createdDate": "2019-08-24T14:15:22Z",
105    "lastModifiedDate": "2019-08-24T14:15:22Z",
106    "archived": true,
107    "externalId": "string",
108    "id": 0,
109    "priority": 0,
110    "internalId": 0,
111    "pickListCode": "string",
112    "pickListLabel": "string",
113    "label": "string",
114    "cultureId": 0,
115    "labelDtos": [
116      {
117        "createdBy": "string",
118        "lastModifiedBy": "string",
119        "createdDate": "2019-08-24T14:15:22Z",
120        "lastModifiedDate": "2019-08-24T14:15:22Z",
121        "archived": true,
122        "externalId": "string",
123        "id": 0,
124        "cultureId": 0,
125        "value": "string"
126      }
127    ]
128  },
129  "primaryUser": {
130    "createdBy": "string",
131    "lastModifiedBy": "string",
132    "createdDate": "2019-08-24T14:15:22Z",
133    "lastModifiedDate": "2019-08-24T14:15:22Z",
134    "archived": true,
135    "externalId": "string",
136    "id": 0,
137    "email": "string",
138    "userName": "string",
139    "firstName": "string",
140    "lastName": "string",
141    "displayName": "string",
142    "permissions": "string",
143    "internalId": "string",
144    "preferredCulture": {
145      "createdBy": "string",
146      "lastModifiedBy": "string",
147      "createdDate": "2019-08-24T14:15:22Z",
148      "lastModifiedDate": "2019-08-24T14:15:22Z",
149      "archived": true,
150      "externalId": "string",
151      "id": 0,
152      "name": "string",
153      "code": "string",
154      "defaultCulture": true,
155      "enable": true
156    },
157    "userGroups": [
158      {
159        "createdBy": "string",
160        "lastModifiedBy": "string",
161        "createdDate": "2019-08-24T14:15:22Z",
162        "lastModifiedDate": "2019-08-24T14:15:22Z",
163        "archived": true,
164        "externalId": "string",
165        "id": 0,
166        "name": "string",
167        "description": "string",
168        "internalId": "string"
169      }
170    ],
171    "partnerIds": [
172      0
173    ],
174    "partners": [
175      {
176        "id": 0,
177        "status": "CREATED",
178        "displayId": "string",
179        "erpSystemId": 0,
180        "erpSystemDisplayId": "string",
181        "name": "string",
182        "fax": "string",
183        "phone": "string",
184        "parentId": 0,
185        "parentName": "string",
186        "parentDisplayId": "string",
187        "companyId": 0,
188        "partnerRoleId": 0,
189        "partnerContactId": 0
190      }
191    ]
192  },
193  "leaseExternalId": "string",
194  "premiseName": "string",
195  "reminderUserDtos": [
196    {
197      "createdBy": "string",
198      "lastModifiedBy": "string",
199      "createdDate": "2019-08-24T14:15:22Z",
200      "lastModifiedDate": "2019-08-24T14:15:22Z",
201      "archived": true,
202      "externalId": "string",
203      "acknowledge": true,
204      "userDto": {
205        "createdBy": "string",
206        "lastModifiedBy": "string",
207        "createdDate": "2019-08-24T14:15:22Z",
208        "lastModifiedDate": "2019-08-24T14:15:22Z",
209        "archived": true,
210        "externalId": "string",
211        "id": 0,
212        "email": "string",
213        "userName": "string",
214        "firstName": "string",
215        "lastName": "string",
216        "displayName": "string",
217        "permissions": "string",
218        "internalId": "string",
219        "preferredCulture": {
220          "createdBy": "string",
221          "lastModifiedBy": "string",
222          "createdDate": "2019-08-24T14:15:22Z",
223          "lastModifiedDate": "2019-08-24T14:15:22Z",
224          "archived": true,
225          "externalId": "string",
226          "id": 0,
227          "name": "string",
228          "code": "string",
229          "defaultCulture": true,
230          "enable": true
231        },
232        "userGroups": [
233          {
234            "createdBy": "string",
235            "lastModifiedBy": "string",
236            "createdDate": "2019-08-24T14:15:22Z",
237            "lastModifiedDate": "2019-08-24T14:15:22Z",
238            "archived": true,
239            "externalId": "string",
240            "id": 0,
241            "name": "string",
242            "description": "string",
243            "internalId": "string"
244          }
245        ],
246        "partnerIds": [
247          0
248        ],
249        "partners": [
250          {
251            "id": 0,
252            "status": "CREATED",
253            "displayId": "string",
254            "erpSystemId": 0,
255            "erpSystemDisplayId": "string",
256            "name": "string",
257            "fax": "string",
258            "phone": "string",
259            "parentId": 0,
260            "parentName": "string",
261            "parentDisplayId": "string",
262            "companyId": 0,
263            "partnerRoleId": 0,
264            "partnerContactId": 0
265          }
266        ]
267      }
268    }
269  ]
270}

Reminder - Get Reminders

HTTP Request

GET /api/reminders

📋 Description: Retrieves a list of reminders associated with portfolio assets, providing insights for effective management and analytics within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the reminder retrieval should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite for portfolio and asset analytics.

subject-id

query

string

false

Unique identifier for the subject associated with the reminder, facilitating targeted retrieval of portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.

category-id

query

string

false

Unique identifier for the category of reminders within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of portfolio, asset, and real estate property analytics.

lease-id

query

string

false

Unique identifier for the lease associated with the portfolio, enabling retrieval of relevant reminders within the Nakisa Portfolio Management Suite.

lease-id-in

query

string

false

Unique identifier for the lease associated with the portfolio or asset, used to retrieve relevant reminders in the Nakisa Portfolio Management Suite.

status-id

query

string

false

Unique identifier for the status of reminders within the Nakisa Portfolio Management Suite, facilitating effective tracking and management of portfolio, asset, and real estate property analytics.

status-id-in

query

string

false

Specifies the unique identifier for the status of reminders within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of reminders related to portfolio, asset, analytics, and real estate property management.

reminder-type-id

query

string

false

Unique identifier for the type of reminder associated with portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite.

reminder-type-id-in

query

string

false

Unique identifier for the type of reminder to filter reminders related to portfolio, asset, analytics, or real estate property within the Nakisa Portfolio Management Suite.

date

query

string

false

Date of the resource

follow-up-date

query

string

false

Specifies the date for follow-up reminders related to portfolio and asset management within the Nakisa Portfolio Management Suite.

follow-up-date-before

query

string

false

Specifies the cutoff date for retrieving reminders related to portfolio and asset management within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelReminderDto

Example Responses

  1{
  2  "_embedded": {
  3    "reminders": [
  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        "subjectId": 0,
 13        "categoryId": 0,
 14        "statusId": 0,
 15        "reminderTypeId": 0,
 16        "date": "2019-08-24",
 17        "followUpDate": "2019-08-24",
 18        "comments": "string",
 19        "primaryUserId": 0,
 20        "subject": {
 21          "createdBy": "string",
 22          "lastModifiedBy": "string",
 23          "createdDate": "2019-08-24T14:15:22Z",
 24          "lastModifiedDate": "2019-08-24T14:15:22Z",
 25          "archived": true,
 26          "externalId": "string",
 27          "id": 0,
 28          "priority": 0,
 29          "internalId": 0,
 30          "pickListCode": "string",
 31          "pickListLabel": "string",
 32          "label": "string",
 33          "cultureId": 0,
 34          "labelDtos": [
 35            {
 36              "createdBy": "string",
 37              "lastModifiedBy": "string",
 38              "createdDate": "2019-08-24T14:15:22Z",
 39              "lastModifiedDate": "2019-08-24T14:15:22Z",
 40              "archived": true,
 41              "externalId": "string",
 42              "id": 0,
 43              "cultureId": 0,
 44              "value": "string"
 45            }
 46          ]
 47        },
 48        "category": {
 49          "createdBy": "string",
 50          "lastModifiedBy": "string",
 51          "createdDate": "2019-08-24T14:15:22Z",
 52          "lastModifiedDate": "2019-08-24T14:15:22Z",
 53          "archived": true,
 54          "externalId": "string",
 55          "id": 0,
 56          "priority": 0,
 57          "internalId": 0,
 58          "pickListCode": "string",
 59          "pickListLabel": "string",
 60          "label": "string",
 61          "cultureId": 0,
 62          "labelDtos": [
 63            {
 64              "createdBy": "string",
 65              "lastModifiedBy": "string",
 66              "createdDate": "2019-08-24T14:15:22Z",
 67              "lastModifiedDate": "2019-08-24T14:15:22Z",
 68              "archived": true,
 69              "externalId": "string",
 70              "id": 0,
 71              "cultureId": 0,
 72              "value": "string"
 73            }
 74          ]
 75        },
 76        "status": {
 77          "createdBy": "string",
 78          "lastModifiedBy": "string",
 79          "createdDate": "2019-08-24T14:15:22Z",
 80          "lastModifiedDate": "2019-08-24T14:15:22Z",
 81          "archived": true,
 82          "externalId": "string",
 83          "id": 0,
 84          "priority": 0,
 85          "internalId": 0,
 86          "pickListCode": "string",
 87          "pickListLabel": "string",
 88          "label": "string",
 89          "cultureId": 0,
 90          "labelDtos": [
 91            {
 92              "createdBy": "string",
 93              "lastModifiedBy": "string",
 94              "createdDate": "2019-08-24T14:15:22Z",
 95              "lastModifiedDate": "2019-08-24T14:15:22Z",
 96              "archived": true,
 97              "externalId": "string",
 98              "id": 0,
 99              "cultureId": 0,
100              "value": "string"
101            }
102          ]
103        },
104        "reminderType": {
105          "createdBy": "string",
106          "lastModifiedBy": "string",
107          "createdDate": "2019-08-24T14:15:22Z",
108          "lastModifiedDate": "2019-08-24T14:15:22Z",
109          "archived": true,
110          "externalId": "string",
111          "id": 0,
112          "priority": 0,
113          "internalId": 0,
114          "pickListCode": "string",
115          "pickListLabel": "string",
116          "label": "string",
117          "cultureId": 0,
118          "labelDtos": [
119            {
120              "createdBy": "string",
121              "lastModifiedBy": "string",
122              "createdDate": "2019-08-24T14:15:22Z",
123              "lastModifiedDate": "2019-08-24T14:15:22Z",
124              "archived": true,
125              "externalId": "string",
126              "id": 0,
127              "cultureId": 0,
128              "value": "string"
129            }
130          ]
131        },
132        "primaryUser": {
133          "createdBy": "string",
134          "lastModifiedBy": "string",
135          "createdDate": "2019-08-24T14:15:22Z",
136          "lastModifiedDate": "2019-08-24T14:15:22Z",
137          "archived": true,
138          "externalId": "string",
139          "id": 0,
140          "email": "string",
141          "userName": "string",
142          "firstName": "string",
143          "lastName": "string",
144          "displayName": "string",
145          "permissions": "string",
146          "internalId": "string",
147          "preferredCulture": {
148            "createdBy": "string",
149            "lastModifiedBy": "string",
150            "createdDate": "2019-08-24T14:15:22Z",
151            "lastModifiedDate": "2019-08-24T14:15:22Z",
152            "archived": true,
153            "externalId": "string",
154            "id": 0,
155            "name": "string",
156            "code": "string",
157            "defaultCulture": true,
158            "enable": true
159          },
160          "userGroups": [
161            {
162              "createdBy": "string",
163              "lastModifiedBy": "string",
164              "createdDate": "2019-08-24T14:15:22Z",
165              "lastModifiedDate": "2019-08-24T14:15:22Z",
166              "archived": true,
167              "externalId": "string",
168              "id": 0,
169              "name": "string",
170              "description": "string",
171              "internalId": "string"
172            }
173          ],
174          "partnerIds": [
175            0
176          ],
177          "partners": [
178            {
179              "id": 0,
180              "status": "CREATED",
181              "displayId": "string",
182              "erpSystemId": 0,
183              "erpSystemDisplayId": "string",
184              "name": "string",
185              "fax": "string",
186              "phone": "string",
187              "parentId": 0,
188              "parentName": "string",
189              "parentDisplayId": "string",
190              "companyId": 0,
191              "partnerRoleId": 0,
192              "partnerContactId": 0
193            }
194          ]
195        },
196        "leaseExternalId": "string",
197        "premiseName": "string",
198        "reminderUserDtos": [
199          {
200            "createdBy": "string",
201            "lastModifiedBy": "string",
202            "createdDate": "2019-08-24T14:15:22Z",
203            "lastModifiedDate": "2019-08-24T14:15:22Z",
204            "archived": true,
205            "externalId": "string",
206            "acknowledge": true,
207            "userDto": {
208              "createdBy": "string",
209              "lastModifiedBy": "string",
210              "createdDate": "2019-08-24T14:15:22Z",
211              "lastModifiedDate": "2019-08-24T14:15:22Z",
212              "archived": true,
213              "externalId": "string",
214              "id": 0,
215              "email": "string",
216              "userName": "string",
217              "firstName": "string",
218              "lastName": "string",
219              "displayName": "string",
220              "permissions": "string",
221              "internalId": "string",
222              "preferredCulture": {
223                "createdBy": "string",
224                "lastModifiedBy": "string",
225                "createdDate": "2019-08-24T14:15:22Z",
226                "lastModifiedDate": "2019-08-24T14:15:22Z",
227                "archived": true,
228                "externalId": "string",
229                "id": 0,
230                "name": "string",
231                "code": "string",
232                "defaultCulture": true,
233                "enable": true
234              },
235              "userGroups": [
236                {
237                  "createdBy": "string",
238                  "lastModifiedBy": "string",
239                  "createdDate": "2019-08-24T14:15:22Z",
240                  "lastModifiedDate": "2019-08-24T14:15:22Z",
241                  "archived": true,
242                  "externalId": "string",
243                  "id": 0,
244                  "name": "string",
245                  "description": "string",
246                  "internalId": "string"
247                }
248              ],
249              "partnerIds": [
250                0
251              ],
252              "partners": [
253                {
254                  "id": 0,
255                  "status": "CREATED",
256                  "displayId": "string",
257                  "erpSystemId": 0,
258                  "erpSystemDisplayId": "string",
259                  "name": "string",
260                  "fax": "string",
261                  "phone": "string",
262                  "parentId": 0,
263                  "parentName": "string",
264                  "parentDisplayId": "string",
265                  "companyId": 0,
266                  "partnerRoleId": 0,
267                  "partnerContactId": 0
268                }
269              ]
270            }
271          }
272        ]
273      }
274    ]
275  },
276  "page": {
277    "size": 0,
278    "totalElements": 0,
279    "totalPages": 0,
280    "number": 0
281  }
282}

Reminder - Get Reminder Users

HTTP Request

GET /api/reminders/{id}/reminder-users

📋 Description: Retrieves the list of users associated with a specific reminder in the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset management within real estate properties.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the response should be paginated, allowing users to efficiently retrieve reminder user data within the Nakisa Portfolio Management Suite.

id

path

string

true

Unique identifier for the resource

user-name

query

string

false

Specifies the username of the individual associated with the reminder in the Nakisa Portfolio Management Suite, facilitating user-specific reminder retrieval within the context of portfolio and asset management.

email

query

string

false

Email address of the user associated with the reminder, facilitating communication within the Nakisa Portfolio Management Suite for effective portfolio and asset management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelReminderUserDto

Example Responses

 1{
 2  "_embedded": {
 3    "reminderUsers": [
 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        "acknowledge": true,
12        "userDto": {
13          "createdBy": "string",
14          "lastModifiedBy": "string",
15          "createdDate": "2019-08-24T14:15:22Z",
16          "lastModifiedDate": "2019-08-24T14:15:22Z",
17          "archived": true,
18          "externalId": "string",
19          "id": 0,
20          "email": "string",
21          "userName": "string",
22          "firstName": "string",
23          "lastName": "string",
24          "displayName": "string",
25          "permissions": "string",
26          "internalId": "string",
27          "preferredCulture": {
28            "createdBy": "string",
29            "lastModifiedBy": "string",
30            "createdDate": "2019-08-24T14:15:22Z",
31            "lastModifiedDate": "2019-08-24T14:15:22Z",
32            "archived": true,
33            "externalId": "string",
34            "id": 0,
35            "name": "string",
36            "code": "string",
37            "defaultCulture": true,
38            "enable": true
39          },
40          "userGroups": [
41            {
42              "createdBy": "string",
43              "lastModifiedBy": "string",
44              "createdDate": "2019-08-24T14:15:22Z",
45              "lastModifiedDate": "2019-08-24T14:15:22Z",
46              "archived": true,
47              "externalId": "string",
48              "id": 0,
49              "name": "string",
50              "description": "string",
51              "internalId": "string"
52            }
53          ],
54          "partnerIds": [
55            0
56          ],
57          "partners": [
58            {
59              "id": 0,
60              "status": "CREATED",
61              "displayId": "string",
62              "erpSystemId": 0,
63              "erpSystemDisplayId": "string",
64              "name": "string",
65              "fax": "string",
66              "phone": "string",
67              "parentId": 0,
68              "parentName": "string",
69              "parentDisplayId": "string",
70              "companyId": 0,
71              "partnerRoleId": 0,
72              "partnerContactId": 0
73            }
74          ]
75        }
76      }
77    ]
78  },
79  "page": {
80    "size": 0,
81    "totalElements": 0,
82    "totalPages": 0,
83    "number": 0
84  }
85}