Proposal Email¶
Proposal Email - Get Proposal Email¶
HTTP Request
GET /api/proposal-emails/{id}
📋 Description: Fetches the proposal email details associated with a specific asset in the Nakisa Portfolio Management Suite, enabling users to access critical communications related to portfolio and real estate property management.
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 "sender": "string",
10 "subject": "string",
11 "message": "string",
12 "nbSent": 0,
13 "lastEmailSent": "2019-08-24",
14 "proposal": {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "receivedDate": "2019-08-24",
23 "receivedViaId": 0,
24 "followUpDate": "2019-08-24",
25 "proposalStatusId": 0,
26 "siteName": "string",
27 "siteCivicNumber": "string",
28 "siteStreet": "string",
29 "siteSuite": "string",
30 "sitePostalCode": "string",
31 "siteLon": 0.1,
32 "siteLat": 0.1,
33 "siteLot": "string",
34 "siteNearbyAddress": "string",
35 "siteNearby": "string",
36 "addressTrafficTypeId": 0,
37 "siteCityId": 0,
38 "siteDistrictId": 0,
39 "evaluatedById": 0,
40 "evaluatedMailViaId": 0,
41 "progressStatusId": 0,
42 "evaluatedDate": "string",
43 "evaluatedComment": "string",
44 "premiseId": 0
45 },
46 "proposalId": 0,
47 "recipients": [
48 {
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 "firstName": "string",
57 "lastName": "string",
58 "email": "string",
59 "isAcknowledge": true,
60 "dateAcknowledge": "2019-08-24",
61 "userId": 0,
62 "user": {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "email": "string",
71 "userName": "string",
72 "firstName": "string",
73 "lastName": "string",
74 "displayName": "string",
75 "permissions": "string",
76 "internalId": "string",
77 "preferredCulture": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "name": "string",
86 "code": "string",
87 "defaultCulture": true,
88 "enable": true
89 },
90 "userGroups": [
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 "name": "string",
100 "description": "string",
101 "internalId": "string"
102 }
103 ],
104 "partnerIds": [
105 0
106 ],
107 "partners": [
108 {
109 "id": 0,
110 "status": "CREATED",
111 "displayId": "string",
112 "erpSystemId": 0,
113 "erpSystemDisplayId": "string",
114 "name": "string",
115 "fax": "string",
116 "phone": "string",
117 "parentId": 0,
118 "parentName": "string",
119 "parentDisplayId": "string",
120 "companyId": 0,
121 "partnerRoleId": 0,
122 "partnerContactId": 0
123 }
124 ]
125 },
126 "proposalEmailId": 0
127 }
128 ]
129}
Proposal Email - Update Proposal Email¶
HTTP Request
PUT /api/proposal-emails/{id}
📋 Description: Updates the details of a specific proposal email identified by its unique ID, enabling users to manage communication related to portfolio, asset, and real estate property analytics effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated proposal email details, including recipient information, subject, and body content, relevant to portfolio and asset management 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 "sender": "string",
10 "subject": "string",
11 "message": "string",
12 "nbSent": 0,
13 "lastEmailSent": "2019-08-24",
14 "proposal": {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "receivedDate": "2019-08-24",
23 "receivedViaId": 0,
24 "followUpDate": "2019-08-24",
25 "proposalStatusId": 0,
26 "siteName": "string",
27 "siteCivicNumber": "string",
28 "siteStreet": "string",
29 "siteSuite": "string",
30 "sitePostalCode": "string",
31 "siteLon": 0.1,
32 "siteLat": 0.1,
33 "siteLot": "string",
34 "siteNearbyAddress": "string",
35 "siteNearby": "string",
36 "addressTrafficTypeId": 0,
37 "siteCityId": 0,
38 "siteDistrictId": 0,
39 "evaluatedById": 0,
40 "evaluatedMailViaId": 0,
41 "progressStatusId": 0,
42 "evaluatedDate": "string",
43 "evaluatedComment": "string",
44 "premiseId": 0
45 },
46 "proposalId": 0,
47 "recipients": [
48 {
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 "firstName": "string",
57 "lastName": "string",
58 "email": "string",
59 "isAcknowledge": true,
60 "dateAcknowledge": "2019-08-24",
61 "userId": 0,
62 "user": {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "email": "string",
71 "userName": "string",
72 "firstName": "string",
73 "lastName": "string",
74 "displayName": "string",
75 "permissions": "string",
76 "internalId": "string",
77 "preferredCulture": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "name": "string",
86 "code": "string",
87 "defaultCulture": true,
88 "enable": true
89 },
90 "userGroups": [
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 "name": "string",
100 "description": "string",
101 "internalId": "string"
102 }
103 ],
104 "partnerIds": [
105 0
106 ],
107 "partners": [
108 {
109 "id": 0,
110 "status": "CREATED",
111 "displayId": "string",
112 "erpSystemId": 0,
113 "erpSystemDisplayId": "string",
114 "name": "string",
115 "fax": "string",
116 "phone": "string",
117 "parentId": 0,
118 "parentName": "string",
119 "parentDisplayId": "string",
120 "companyId": 0,
121 "partnerRoleId": 0,
122 "partnerContactId": 0
123 }
124 ]
125 },
126 "proposalEmailId": 0
127 }
128 ]
129}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Proposal Email - Delete Proposal Email¶
HTTP Request
DELETE /api/proposal-emails/{id}
📋 Description: Deletes a specified proposal email from the Nakisa Portfolio Management Suite, facilitating the management of communication related to portfolio and asset analytics in real estate property transactions.
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 |
Proposal Email - Get Proposal Emails¶
HTTP Request
GET /api/proposal-emails
📋 Description: Retrieves proposal email records related to portfolio and asset management within the Nakisa Portfolio Management Suite, enabling users to analyze communications associated with real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the proposal emails query should be returned in a paginated format, facilitating efficient data retrieval within the Nakisa Portfolio Management Suite. |
|
listing |
query |
boolean |
false |
Indicates whether to include detailed listing information in the proposal emails retrieved from the Nakisa Portfolio Management Suite, enhancing insights for portfolio and asset analytics in the real estate sector. |
proposal-id |
query |
string |
false |
Unique identifier for the proposal within the Nakisa Portfolio Management Suite, facilitating the retrieval of associated email communications related to portfolio and asset management. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "proposalEmails": [
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 "sender": "string",
13 "subject": "string",
14 "message": "string",
15 "nbSent": 0,
16 "lastEmailSent": "2019-08-24",
17 "proposal": {
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 "receivedDate": "2019-08-24",
26 "receivedViaId": 0,
27 "followUpDate": "2019-08-24",
28 "proposalStatusId": 0,
29 "siteName": "string",
30 "siteCivicNumber": "string",
31 "siteStreet": "string",
32 "siteSuite": "string",
33 "sitePostalCode": "string",
34 "siteLon": 0.1,
35 "siteLat": 0.1,
36 "siteLot": "string",
37 "siteNearbyAddress": "string",
38 "siteNearby": "string",
39 "addressTrafficTypeId": 0,
40 "siteCityId": 0,
41 "siteDistrictId": 0,
42 "evaluatedById": 0,
43 "evaluatedMailViaId": 0,
44 "progressStatusId": 0,
45 "evaluatedDate": "string",
46 "evaluatedComment": "string",
47 "premiseId": 0
48 },
49 "proposalId": 0,
50 "recipients": [
51 {
52 "createdBy": "string",
53 "lastModifiedBy": "string",
54 "createdDate": "2019-08-24T14:15:22Z",
55 "lastModifiedDate": "2019-08-24T14:15:22Z",
56 "archived": true,
57 "externalId": "string",
58 "id": 0,
59 "firstName": "string",
60 "lastName": "string",
61 "email": "string",
62 "isAcknowledge": true,
63 "dateAcknowledge": "2019-08-24",
64 "userId": 0,
65 "user": {
66 "createdBy": "string",
67 "lastModifiedBy": "string",
68 "createdDate": "2019-08-24T14:15:22Z",
69 "lastModifiedDate": "2019-08-24T14:15:22Z",
70 "archived": true,
71 "externalId": "string",
72 "id": 0,
73 "email": "string",
74 "userName": "string",
75 "firstName": "string",
76 "lastName": "string",
77 "displayName": "string",
78 "permissions": "string",
79 "internalId": "string",
80 "preferredCulture": {
81 "createdBy": "string",
82 "lastModifiedBy": "string",
83 "createdDate": "2019-08-24T14:15:22Z",
84 "lastModifiedDate": "2019-08-24T14:15:22Z",
85 "archived": true,
86 "externalId": "string",
87 "id": 0,
88 "name": "string",
89 "code": "string",
90 "defaultCulture": true,
91 "enable": true
92 },
93 "userGroups": [
94 {
95 "createdBy": "string",
96 "lastModifiedBy": "string",
97 "createdDate": "2019-08-24T14:15:22Z",
98 "lastModifiedDate": "2019-08-24T14:15:22Z",
99 "archived": true,
100 "externalId": "string",
101 "id": 0,
102 "name": "string",
103 "description": "string",
104 "internalId": "string"
105 }
106 ],
107 "partnerIds": [
108 0
109 ],
110 "partners": [
111 {
112 "id": 0,
113 "status": "CREATED",
114 "displayId": "string",
115 "erpSystemId": 0,
116 "erpSystemDisplayId": "string",
117 "name": "string",
118 "fax": "string",
119 "phone": "string",
120 "parentId": 0,
121 "parentName": "string",
122 "parentDisplayId": "string",
123 "companyId": 0,
124 "partnerRoleId": 0,
125 "partnerContactId": 0
126 }
127 ]
128 },
129 "proposalEmailId": 0
130 }
131 ]
132 }
133 ]
134 },
135 "page": {
136 "size": 0,
137 "totalElements": 0,
138 "totalPages": 0,
139 "number": 0
140 }
141}
Proposal Email - Create Proposal Email¶
HTTP Request
POST /api/proposal-emails
📋 Description: Creates and sends proposal emails related to portfolio assets within the Nakisa Portfolio Management Suite, facilitating streamlined communication for real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the proposal email details, including recipient information, subject, and content, relevant for portfolio and asset management communications 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 "sender": "string",
10 "subject": "string",
11 "message": "string",
12 "nbSent": 0,
13 "lastEmailSent": "2019-08-24",
14 "proposal": {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "receivedDate": "2019-08-24",
23 "receivedViaId": 0,
24 "followUpDate": "2019-08-24",
25 "proposalStatusId": 0,
26 "siteName": "string",
27 "siteCivicNumber": "string",
28 "siteStreet": "string",
29 "siteSuite": "string",
30 "sitePostalCode": "string",
31 "siteLon": 0.1,
32 "siteLat": 0.1,
33 "siteLot": "string",
34 "siteNearbyAddress": "string",
35 "siteNearby": "string",
36 "addressTrafficTypeId": 0,
37 "siteCityId": 0,
38 "siteDistrictId": 0,
39 "evaluatedById": 0,
40 "evaluatedMailViaId": 0,
41 "progressStatusId": 0,
42 "evaluatedDate": "string",
43 "evaluatedComment": "string",
44 "premiseId": 0
45 },
46 "proposalId": 0,
47 "recipients": [
48 {
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 "firstName": "string",
57 "lastName": "string",
58 "email": "string",
59 "isAcknowledge": true,
60 "dateAcknowledge": "2019-08-24",
61 "userId": 0,
62 "user": {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "email": "string",
71 "userName": "string",
72 "firstName": "string",
73 "lastName": "string",
74 "displayName": "string",
75 "permissions": "string",
76 "internalId": "string",
77 "preferredCulture": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "name": "string",
86 "code": "string",
87 "defaultCulture": true,
88 "enable": true
89 },
90 "userGroups": [
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 "name": "string",
100 "description": "string",
101 "internalId": "string"
102 }
103 ],
104 "partnerIds": [
105 0
106 ],
107 "partners": [
108 {
109 "id": 0,
110 "status": "CREATED",
111 "displayId": "string",
112 "erpSystemId": 0,
113 "erpSystemDisplayId": "string",
114 "name": "string",
115 "fax": "string",
116 "phone": "string",
117 "parentId": 0,
118 "parentName": "string",
119 "parentDisplayId": "string",
120 "companyId": 0,
121 "partnerRoleId": 0,
122 "partnerContactId": 0
123 }
124 ]
125 },
126 "proposalEmailId": 0
127 }
128 ]
129}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10
Proposal Email - Create Proposal Email Notification¶
HTTP Request
POST /api/proposal-emails/send
📋 Description: Send proposal emails related to portfolio and asset management within the Nakisa Portfolio Management Suite, facilitating communication and collaboration on real estate property analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the proposal email details, including recipient information, subject, and content, essential for effective communication regarding portfolio and asset management in the real estate sector. |
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 "sender": "string",
10 "subject": "string",
11 "message": "string",
12 "nbSent": 0,
13 "lastEmailSent": "2019-08-24",
14 "proposal": {
15 "createdBy": "string",
16 "lastModifiedBy": "string",
17 "createdDate": "2019-08-24T14:15:22Z",
18 "lastModifiedDate": "2019-08-24T14:15:22Z",
19 "archived": true,
20 "externalId": "string",
21 "id": 0,
22 "receivedDate": "2019-08-24",
23 "receivedViaId": 0,
24 "followUpDate": "2019-08-24",
25 "proposalStatusId": 0,
26 "siteName": "string",
27 "siteCivicNumber": "string",
28 "siteStreet": "string",
29 "siteSuite": "string",
30 "sitePostalCode": "string",
31 "siteLon": 0.1,
32 "siteLat": 0.1,
33 "siteLot": "string",
34 "siteNearbyAddress": "string",
35 "siteNearby": "string",
36 "addressTrafficTypeId": 0,
37 "siteCityId": 0,
38 "siteDistrictId": 0,
39 "evaluatedById": 0,
40 "evaluatedMailViaId": 0,
41 "progressStatusId": 0,
42 "evaluatedDate": "string",
43 "evaluatedComment": "string",
44 "premiseId": 0
45 },
46 "proposalId": 0,
47 "recipients": [
48 {
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 "firstName": "string",
57 "lastName": "string",
58 "email": "string",
59 "isAcknowledge": true,
60 "dateAcknowledge": "2019-08-24",
61 "userId": 0,
62 "user": {
63 "createdBy": "string",
64 "lastModifiedBy": "string",
65 "createdDate": "2019-08-24T14:15:22Z",
66 "lastModifiedDate": "2019-08-24T14:15:22Z",
67 "archived": true,
68 "externalId": "string",
69 "id": 0,
70 "email": "string",
71 "userName": "string",
72 "firstName": "string",
73 "lastName": "string",
74 "displayName": "string",
75 "permissions": "string",
76 "internalId": "string",
77 "preferredCulture": {
78 "createdBy": "string",
79 "lastModifiedBy": "string",
80 "createdDate": "2019-08-24T14:15:22Z",
81 "lastModifiedDate": "2019-08-24T14:15:22Z",
82 "archived": true,
83 "externalId": "string",
84 "id": 0,
85 "name": "string",
86 "code": "string",
87 "defaultCulture": true,
88 "enable": true
89 },
90 "userGroups": [
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 "name": "string",
100 "description": "string",
101 "internalId": "string"
102 }
103 ],
104 "partnerIds": [
105 0
106 ],
107 "partners": [
108 {
109 "id": 0,
110 "status": "CREATED",
111 "displayId": "string",
112 "erpSystemId": 0,
113 "erpSystemDisplayId": "string",
114 "name": "string",
115 "fax": "string",
116 "phone": "string",
117 "parentId": 0,
118 "parentName": "string",
119 "parentDisplayId": "string",
120 "companyId": 0,
121 "partnerRoleId": 0,
122 "partnerContactId": 0
123 }
124 ]
125 },
126 "proposalEmailId": 0
127 }
128 ]
129}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |