Proposal Email Recipient¶
Proposal Email Recipient - Get Proposal Email Recipient¶
HTTP Request
GET /api/proposal-email-recipients/{id}
📋 Description: Retrieves the email recipients associated with a specific proposal identified by the given ID, facilitating effective communication within the context of portfolio management and asset analytics.
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 "firstName": "string",
10 "lastName": "string",
11 "email": "string",
12 "isAcknowledge": true,
13 "dateAcknowledge": "2019-08-24",
14 "userId": 0,
15 "user": {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "email": "string",
24 "userName": "string",
25 "firstName": "string",
26 "lastName": "string",
27 "displayName": "string",
28 "permissions": "string",
29 "internalId": "string",
30 "preferredCulture": {
31 "createdBy": "string",
32 "lastModifiedBy": "string",
33 "createdDate": "2019-08-24T14:15:22Z",
34 "lastModifiedDate": "2019-08-24T14:15:22Z",
35 "archived": true,
36 "externalId": "string",
37 "id": 0,
38 "name": "string",
39 "code": "string",
40 "defaultCulture": true,
41 "enable": true
42 },
43 "userGroups": [
44 {
45 "createdBy": "string",
46 "lastModifiedBy": "string",
47 "createdDate": "2019-08-24T14:15:22Z",
48 "lastModifiedDate": "2019-08-24T14:15:22Z",
49 "archived": true,
50 "externalId": "string",
51 "id": 0,
52 "name": "string",
53 "description": "string",
54 "internalId": "string"
55 }
56 ],
57 "partnerIds": [
58 0
59 ],
60 "partners": [
61 {
62 "id": 0,
63 "status": "CREATED",
64 "displayId": "string",
65 "erpSystemId": 0,
66 "erpSystemDisplayId": "string",
67 "name": "string",
68 "fax": "string",
69 "phone": "string",
70 "parentId": 0,
71 "parentName": "string",
72 "parentDisplayId": "string",
73 "companyId": 0,
74 "partnerRoleId": 0,
75 "partnerContactId": 0
76 }
77 ]
78 },
79 "proposalEmailId": 0
80}
Proposal Email Recipient - Update Proposal Email Recipient¶
HTTP Request
PUT /api/proposal-email-recipients/{id}
📋 Description: Updates the email recipients associated with a specific proposal in the Nakisa Portfolio Management Suite, enabling effective communication and collaboration within portfolio, asset, and real estate property management.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing updated email recipient information for a specific proposal, including recipient details and preferences relevant to portfolio management and asset analytics. |
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 "firstName": "string",
10 "lastName": "string",
11 "email": "string",
12 "isAcknowledge": true,
13 "dateAcknowledge": "2019-08-24",
14 "userId": 0,
15 "user": {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "email": "string",
24 "userName": "string",
25 "firstName": "string",
26 "lastName": "string",
27 "displayName": "string",
28 "permissions": "string",
29 "internalId": "string",
30 "preferredCulture": {
31 "createdBy": "string",
32 "lastModifiedBy": "string",
33 "createdDate": "2019-08-24T14:15:22Z",
34 "lastModifiedDate": "2019-08-24T14:15:22Z",
35 "archived": true,
36 "externalId": "string",
37 "id": 0,
38 "name": "string",
39 "code": "string",
40 "defaultCulture": true,
41 "enable": true
42 },
43 "userGroups": [
44 {
45 "createdBy": "string",
46 "lastModifiedBy": "string",
47 "createdDate": "2019-08-24T14:15:22Z",
48 "lastModifiedDate": "2019-08-24T14:15:22Z",
49 "archived": true,
50 "externalId": "string",
51 "id": 0,
52 "name": "string",
53 "description": "string",
54 "internalId": "string"
55 }
56 ],
57 "partnerIds": [
58 0
59 ],
60 "partners": [
61 {
62 "id": 0,
63 "status": "CREATED",
64 "displayId": "string",
65 "erpSystemId": 0,
66 "erpSystemDisplayId": "string",
67 "name": "string",
68 "fax": "string",
69 "phone": "string",
70 "parentId": 0,
71 "parentName": "string",
72 "parentDisplayId": "string",
73 "companyId": 0,
74 "partnerRoleId": 0,
75 "partnerContactId": 0
76 }
77 ]
78 },
79 "proposalEmailId": 0
80}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Proposal Email Recipient - Delete Proposal Email Recipient¶
HTTP Request
DELETE /api/proposal-email-recipients/{id}
📋 Description: Deletes a specified email recipient from the proposal distribution list within the Nakisa Portfolio Management Suite, ensuring streamlined communication for portfolio, 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 |
Proposal Email Recipient - Get Proposal Email Recipients¶
HTTP Request
GET /api/proposal-email-recipients
📋 Description: Retrieves the list of email recipients associated with proposals in the Nakisa Portfolio Management Suite, facilitating streamlined communication for portfolio and asset management in real estate analytics.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the response should be paginated, allowing users to efficiently retrieve and manage proposal email recipients within the Nakisa Portfolio Management Suite. |
|
listing |
query |
boolean |
false |
Indicates whether to include listing details in the proposal email recipients response, relevant for portfolio and asset analytics within the Nakisa Portfolio Management Suite. |
proposal-email-id |
query |
string |
false |
Unique identifier for the proposal email recipient, facilitating targeted communication within the Nakisa Portfolio Management Suite’s asset and portfolio analytics framework. |
proposal-id |
query |
string |
false |
Unique identifier for the proposal, used to retrieve associated email recipients within the Nakisa Portfolio Management Suite. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "proposalEmailRecipients": [
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 "firstName": "string",
13 "lastName": "string",
14 "email": "string",
15 "isAcknowledge": true,
16 "dateAcknowledge": "2019-08-24",
17 "userId": 0,
18 "user": {
19 "createdBy": "string",
20 "lastModifiedBy": "string",
21 "createdDate": "2019-08-24T14:15:22Z",
22 "lastModifiedDate": "2019-08-24T14:15:22Z",
23 "archived": true,
24 "externalId": "string",
25 "id": 0,
26 "email": "string",
27 "userName": "string",
28 "firstName": "string",
29 "lastName": "string",
30 "displayName": "string",
31 "permissions": "string",
32 "internalId": "string",
33 "preferredCulture": {
34 "createdBy": "string",
35 "lastModifiedBy": "string",
36 "createdDate": "2019-08-24T14:15:22Z",
37 "lastModifiedDate": "2019-08-24T14:15:22Z",
38 "archived": true,
39 "externalId": "string",
40 "id": 0,
41 "name": "string",
42 "code": "string",
43 "defaultCulture": true,
44 "enable": true
45 },
46 "userGroups": [
47 {
48 "createdBy": "string",
49 "lastModifiedBy": "string",
50 "createdDate": "2019-08-24T14:15:22Z",
51 "lastModifiedDate": "2019-08-24T14:15:22Z",
52 "archived": true,
53 "externalId": "string",
54 "id": 0,
55 "name": "string",
56 "description": "string",
57 "internalId": "string"
58 }
59 ],
60 "partnerIds": [
61 0
62 ],
63 "partners": [
64 {
65 "id": 0,
66 "status": "CREATED",
67 "displayId": "string",
68 "erpSystemId": 0,
69 "erpSystemDisplayId": "string",
70 "name": "string",
71 "fax": "string",
72 "phone": "string",
73 "parentId": 0,
74 "parentName": "string",
75 "parentDisplayId": "string",
76 "companyId": 0,
77 "partnerRoleId": 0,
78 "partnerContactId": 0
79 }
80 ]
81 },
82 "proposalEmailId": 0
83 }
84 ]
85 },
86 "page": {
87 "size": 0,
88 "totalElements": 0,
89 "totalPages": 0,
90 "number": 0
91 }
92}
Proposal Email Recipient - Create Proposal Email Recipient¶
HTTP Request
POST /api/proposal-email-recipients
📋 Description: Adds email recipients to proposal notifications within the Nakisa Portfolio Management Suite, facilitating streamlined communication regarding portfolio and asset analytics for real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the email recipient details for portfolio proposals, including recipient names, email addresses, and associated asset identifiers. |
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 "firstName": "string",
10 "lastName": "string",
11 "email": "string",
12 "isAcknowledge": true,
13 "dateAcknowledge": "2019-08-24",
14 "userId": 0,
15 "user": {
16 "createdBy": "string",
17 "lastModifiedBy": "string",
18 "createdDate": "2019-08-24T14:15:22Z",
19 "lastModifiedDate": "2019-08-24T14:15:22Z",
20 "archived": true,
21 "externalId": "string",
22 "id": 0,
23 "email": "string",
24 "userName": "string",
25 "firstName": "string",
26 "lastName": "string",
27 "displayName": "string",
28 "permissions": "string",
29 "internalId": "string",
30 "preferredCulture": {
31 "createdBy": "string",
32 "lastModifiedBy": "string",
33 "createdDate": "2019-08-24T14:15:22Z",
34 "lastModifiedDate": "2019-08-24T14:15:22Z",
35 "archived": true,
36 "externalId": "string",
37 "id": 0,
38 "name": "string",
39 "code": "string",
40 "defaultCulture": true,
41 "enable": true
42 },
43 "userGroups": [
44 {
45 "createdBy": "string",
46 "lastModifiedBy": "string",
47 "createdDate": "2019-08-24T14:15:22Z",
48 "lastModifiedDate": "2019-08-24T14:15:22Z",
49 "archived": true,
50 "externalId": "string",
51 "id": 0,
52 "name": "string",
53 "description": "string",
54 "internalId": "string"
55 }
56 ],
57 "partnerIds": [
58 0
59 ],
60 "partners": [
61 {
62 "id": 0,
63 "status": "CREATED",
64 "displayId": "string",
65 "erpSystemId": 0,
66 "erpSystemDisplayId": "string",
67 "name": "string",
68 "fax": "string",
69 "phone": "string",
70 "parentId": 0,
71 "parentName": "string",
72 "parentDisplayId": "string",
73 "companyId": 0,
74 "partnerRoleId": 0,
75 "partnerContactId": 0
76 }
77 ]
78 },
79 "proposalEmailId": 0
80}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
integer |
Example Responses
10