Insurance¶
Insurance - Get Insurance¶
HTTP Request
GET /api/insurances/{id}
📋 Description: Retrieves detailed information about a specific insurance policy associated with a portfolio asset, enabling users to analyze coverage and risk factors 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 |
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 "pageNumber": "string",
11 "section": "string",
12 "amount": 0,
13 "type": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "priority": 0,
22 "internalId": 0,
23 "pickListCode": "string",
24 "pickListLabel": "string",
25 "label": "string",
26 "cultureId": 0,
27 "labelDtos": [
28 {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "cultureId": 0,
37 "value": "string"
38 }
39 ]
40 }
41}
Insurance - Update Insurance¶
HTTP Request
PUT /api/insurances/{id}
📋 Description: Updates the details of a specific insurance record identified by its unique ID within the Nakisa Portfolio Management Suite, facilitating accurate asset and portfolio management in the context of real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated insurance details, including coverage information and policy terms, relevant for managing real estate property assets 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 "typeId": 0,
10 "pageNumber": "string",
11 "section": "string",
12 "amount": 0,
13 "type": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "priority": 0,
22 "internalId": 0,
23 "pickListCode": "string",
24 "pickListLabel": "string",
25 "label": "string",
26 "cultureId": 0,
27 "labelDtos": [
28 {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "cultureId": 0,
37 "value": "string"
38 }
39 ]
40 }
41}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "pageNumber": "string",
11 "section": "string",
12 "amount": 0,
13 "type": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "priority": 0,
22 "internalId": 0,
23 "pickListCode": "string",
24 "pickListLabel": "string",
25 "label": "string",
26 "cultureId": 0,
27 "labelDtos": [
28 {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "cultureId": 0,
37 "value": "string"
38 }
39 ]
40 }
41}
Insurance - Delete Insurance¶
HTTP Request
DELETE /api/insurances/{id}
📋 Description: Deletes a specified insurance record from the Nakisa Portfolio Management Suite, ensuring accurate and up-to-date asset management within the portfolio 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 |
Insurance - Add Insurance Notes¶
HTTP Request
POST /api/insurances/{id}/notes
📋 Description: Adds a new note to the specified insurance record within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the notes related to a specific insurance asset, including details such as content, author, and timestamp for enhanced portfolio analytics. |
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 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
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 "message": "string",
11 "userIds": [
12 0
13 ],
14 "redirectUrl": "string"
15 }
16]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing a note associated with portfolio management, asset analytics, and real estate properties, facilitating effective communication and documentation within the Nakisa Portfolio Management Suite.] |
|
» 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 |
» message |
string |
true |
none |
Textual content providing detailed information or commentary related to the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite. |
» userIds |
[integer] |
false |
none |
User information related to portfolio management |
» redirectUrl |
string |
false |
none |
URL to which users will be redirected after completing a specific action within the Nakisa Portfolio Management Suite, facilitating seamless navigation in the context of portfolio, asset, and real estate property management. |
Insurance - Archive Insurance¶
HTTP Request
POST /api/insurances/{id}/archive
📋 Description: Archives the specified insurance record within the Nakisa Portfolio Management Suite, enabling effective management of portfolio assets and enhancing 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 |
|---|---|---|---|
200 |
OK |
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 "pageNumber": "string",
11 "section": "string",
12 "amount": 0,
13 "type": {
14 "createdBy": "string",
15 "lastModifiedBy": "string",
16 "createdDate": "2019-08-24T14:15:22Z",
17 "lastModifiedDate": "2019-08-24T14:15:22Z",
18 "archived": true,
19 "externalId": "string",
20 "id": 0,
21 "priority": 0,
22 "internalId": 0,
23 "pickListCode": "string",
24 "pickListLabel": "string",
25 "label": "string",
26 "cultureId": 0,
27 "labelDtos": [
28 {
29 "createdBy": "string",
30 "lastModifiedBy": "string",
31 "createdDate": "2019-08-24T14:15:22Z",
32 "lastModifiedDate": "2019-08-24T14:15:22Z",
33 "archived": true,
34 "externalId": "string",
35 "id": 0,
36 "cultureId": 0,
37 "value": "string"
38 }
39 ]
40 }
41}
Insurance - Get Insurances¶
HTTP Request
GET /api/insurances
📋 Description: Retrieves a comprehensive list of insurance policies associated with real estate assets within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio coverage and risk exposure.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the insurance query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analysis within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific insurance records within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property management. |
lease-id |
query |
string |
false |
Unique identifier for the lease associated with a real estate property, used to retrieve relevant insurance information within the Nakisa Portfolio Management Suite. |
type-id |
query |
string |
false |
Unique identifier for the specific type of insurance within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of insurance data related to portfolio, asset, analytics, and real estate property. |
page-number |
query |
string |
false |
Specifies the page number for retrieving a subset of insurance data within the Nakisa Portfolio Management Suite, facilitating efficient navigation through large datasets in the context of portfolio and asset analytics. |
section |
query |
string |
false |
Specifies the section of the insurance portfolio to retrieve, enabling targeted analytics and insights related to assets within the Nakisa Portfolio Management Suite. |
amount |
query |
string |
false |
Amount value |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "insurances": [
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 "typeId": 0,
13 "pageNumber": "string",
14 "section": "string",
15 "amount": 0,
16 "type": {
17 "createdBy": "string",
18 "lastModifiedBy": "string",
19 "createdDate": "2019-08-24T14:15:22Z",
20 "lastModifiedDate": "2019-08-24T14:15:22Z",
21 "archived": true,
22 "externalId": "string",
23 "id": 0,
24 "priority": 0,
25 "internalId": 0,
26 "pickListCode": "string",
27 "pickListLabel": "string",
28 "label": "string",
29 "cultureId": 0,
30 "labelDtos": [
31 {
32 "createdBy": "string",
33 "lastModifiedBy": "string",
34 "createdDate": "2019-08-24T14:15:22Z",
35 "lastModifiedDate": "2019-08-24T14:15:22Z",
36 "archived": true,
37 "externalId": "string",
38 "id": 0,
39 "cultureId": 0,
40 "value": "string"
41 }
42 ]
43 }
44 }
45 ]
46 },
47 "page": {
48 "size": 0,
49 "totalElements": 0,
50 "totalPages": 0,
51 "number": 0
52 }
53}
Insurance - Get Insurance Notes¶
HTTP Request
GET /api/insurances/{insuranceId}/notes
📋 Description: Retrieves notes associated with a specific insurance record, providing insights into portfolio management and asset analytics within the Nakisa Portfolio Management Suite.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
insuranceId |
path |
integer(int64) |
true |
Unique identifier for the insurance |
pageable |
query |
true |
Indicates whether the results of the insurance notes retrieval should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite. |
|
search |
query |
string |
false |
Search term used to filter notes related to a specific insurance policy within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties. |
message |
query |
string |
false |
Textual content of the note associated with a specific insurance entry, facilitating enhanced portfolio and asset management within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "notes": [
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 "message": "string",
13 "userIds": [
14 0
15 ],
16 "redirectUrl": "string"
17 }
18 ]
19 },
20 "page": {
21 "size": 0,
22 "totalElements": 0,
23 "totalPages": 0,
24 "number": 0
25 }
26}