Partner Contact

Partner Contact - Search Partners

HTTP Request

POST /api/partner-contacts/search

📋 Description: Submits a search request for partner contacts within the Nakisa Portfolio Management Suite, enabling users to efficiently locate and analyze relevant portfolio and asset information related to real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

PartnerContactDtoFilter

true

Request body containing search criteria and filters for retrieving partner contact information relevant to portfolio management and real estate asset analytics.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "statusEqual": "CREATED",
16  "statusIn": [
17    "CREATED"
18  ],
19  "displayIdIn": [
20    "string"
21  ],
22  "displayIdLike": "string",
23  "nameLike": "string",
24  "emailLike": "string",
25  "phoneLike": "string",
26  "positionLike": "string",
27  "addressLike": "string",
28  "groupLike": "string",
29  "buildingNameLike": "string",
30  "faxLike": "string",
31  "erpSystemIdEqual": 0,
32  "erpSystemDisplayIdLike": "string",
33  "partnerIdEqual": 0,
34  "contactRoleIdEqual": 0
35}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePartnerContactDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "pageSize": 0,
 7    "unpaged": true,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "sorted": true,
12      "unsorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "name": "string",
24      "email": "string",
25      "phone": "string",
26      "position": "string",
27      "address": "string",
28      "group": "string",
29      "buildingName": "string",
30      "fax": "string",
31      "erpSystemId": 0,
32      "erpSystemDisplayId": "string",
33      "partnerId": 0,
34      "contactRoleId": 0
35    }
36  ],
37  "number": 0,
38  "sort": {
39    "sorted": true,
40    "unsorted": true,
41    "empty": true
42  },
43  "first": true,
44  "last": true,
45  "empty": true
46}

Partner Contact - Search Contact Roles

HTTP Request

POST /api/contact-roles/search

📋 Description: Submits a search request for contact roles within the Nakisa Portfolio Management Suite, enabling users to efficiently identify and analyze relevant roles associated with portfolios, assets, and real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

ContactRoleDtoFilter

true

Request body containing search criteria and filters for identifying specific contact roles within the Nakisa Portfolio Management Suite, relevant to portfolio, asset, analytics, and real estate property management.

Body Parameters

 1{
 2  "idIn": [
 3    0
 4  ],
 5  "idEqual": 0,
 6  "idLike": "string",
 7  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
 8  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
 9  "createdByLike": "string",
10  "createdByEqual": "string",
11  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13  "modifiedByLike": "string",
14  "modifiedByEqual": "string",
15  "statusEqual": "CREATED",
16  "statusIn": [
17    "CREATED"
18  ],
19  "displayIdIn": [
20    "string"
21  ],
22  "displayIdLike": "string",
23  "notDisplayIdIn": [
24    "string"
25  ],
26  "nameLike": "string",
27  "partnerContactIdEqual": 0
28}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageContactRoleDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "pageSize": 0,
 7    "unpaged": true,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "sorted": true,
12      "unsorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "name": "string",
24      "partnerContactId": 0
25    }
26  ],
27  "number": 0,
28  "sort": {
29    "sorted": true,
30    "unsorted": true,
31    "empty": true
32  },
33  "first": true,
34  "last": true,
35  "empty": true
36}

Partner Contact - Find All Partner Contacts

HTTP Request

GET /api/partner-contacts

📋 Description: Retrieves a list of partner contacts associated with real estate properties within the Nakisa Portfolio Management Suite, enabling users to access essential asset and portfolio analytics.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePartnerContactDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "pageSize": 0,
 7    "unpaged": true,
 8    "paged": true,
 9    "offset": 0,
10    "sort": {
11      "sorted": true,
12      "unsorted": true,
13      "empty": true
14    }
15  },
16  "numberOfElements": 0,
17  "size": 0,
18  "content": [
19    {
20      "id": 0,
21      "status": "CREATED",
22      "displayId": "string",
23      "name": "string",
24      "email": "string",
25      "phone": "string",
26      "position": "string",
27      "address": "string",
28      "group": "string",
29      "buildingName": "string",
30      "fax": "string",
31      "erpSystemId": 0,
32      "erpSystemDisplayId": "string",
33      "partnerId": 0,
34      "contactRoleId": 0
35    }
36  ],
37  "number": 0,
38  "sort": {
39    "sorted": true,
40    "unsorted": true,
41    "empty": true
42  },
43  "first": true,
44  "last": true,
45  "empty": true
46}

Partner Contact - Get Partner Contact

HTTP Request

GET /api/partner-contacts/{id}

📋 Description: Fetches detailed information about a specific partner contact within the Nakisa Portfolio Management Suite, facilitating insights into portfolio and asset management related to 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

OK

PartnerContactDto

Example Responses

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "name": "string",
 6  "email": "string",
 7  "phone": "string",
 8  "position": "string",
 9  "address": "string",
10  "group": "string",
11  "buildingName": "string",
12  "fax": "string",
13  "erpSystemId": 0,
14  "erpSystemDisplayId": "string",
15  "partnerId": 0,
16  "contactRoleId": 0
17}