Partner

Partner - Get Partner

HTTP Request

GET /api/partners/{id}

📋 Description: Fetches detailed information about a specific partner within the Nakisa Portfolio Management Suite, enabling users to analyze portfolio and asset relationships in the context of 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

PartnerDto

Example Responses

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "fax": "string",
 9  "phone": "string",
10  "parentId": 0,
11  "parentName": "string",
12  "parentDisplayId": "string",
13  "companyId": 0,
14  "partnerRoleId": 0,
15  "partnerContactId": 0
16}

Partner - Update Partner

HTTP Request

PUT /api/partners/{id}

📋 Description: Updates the details of a specified partner within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets and analytics related to real estate properties effectively.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

PartnerDto

true

Request body containing the updated partner information, including portfolio details, asset allocations, and analytics relevant to real estate property management.

Body Parameters

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "fax": "string",
 9  "phone": "string",
10  "parentId": 0,
11  "parentName": "string",
12  "parentDisplayId": "string",
13  "companyId": 0,
14  "partnerRoleId": 0,
15  "partnerContactId": 0
16}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PartnerDto

Example Responses

 1{
 2  "id": 0,
 3  "status": "CREATED",
 4  "displayId": "string",
 5  "erpSystemId": 0,
 6  "erpSystemDisplayId": "string",
 7  "name": "string",
 8  "fax": "string",
 9  "phone": "string",
10  "parentId": 0,
11  "parentName": "string",
12  "parentDisplayId": "string",
13  "companyId": 0,
14  "partnerRoleId": 0,
15  "partnerContactId": 0
16}

Partner - Delete Partner

HTTP Request

DELETE /api/partners/{id}

📋 Description: Deletes a specified partner from the Nakisa Portfolio Management Suite, ensuring the integrity of your portfolio and asset analytics 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

204

No Content

No Content

None

Partner - Get Partners

HTTP Request

GET /api/partners

📋 Description: Retrieves a list of partners associated with the Nakisa Portfolio Management Suite, enabling users to analyze portfolio relationships and asset management within the real estate property sector.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePartnerDto

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      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "fax": "string",
27      "phone": "string",
28      "parentId": 0,
29      "parentName": "string",
30      "parentDisplayId": "string",
31      "companyId": 0,
32      "partnerRoleId": 0,
33      "partnerContactId": 0
34    }
35  ],
36  "number": 0,
37  "sort": {
38    "sorted": true,
39    "unsorted": true,
40    "empty": true
41  },
42  "first": true,
43  "last": true,
44  "empty": true
45}

Partner - Create Partners

HTTP Request

POST /api/partners

📋 Description: Creates a new partner entry within the Nakisa Portfolio Management Suite, enabling enhanced portfolio and asset management analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

PartnerDto

true

Request body containing the partner information, including details on portfolio alignment, asset management, and analytics relevant to real estate properties.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "fax": "string",
10    "phone": "string",
11    "parentId": 0,
12    "parentName": "string",
13    "parentDisplayId": "string",
14    "companyId": 0,
15    "partnerRoleId": 0,
16    "partnerContactId": 0
17  }
18]

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "status": "CREATED",
 5    "displayId": "string",
 6    "erpSystemId": 0,
 7    "erpSystemDisplayId": "string",
 8    "name": "string",
 9    "fax": "string",
10    "phone": "string",
11    "parentId": 0,
12    "parentName": "string",
13    "parentDisplayId": "string",
14    "companyId": 0,
15    "partnerRoleId": 0,
16    "partnerContactId": 0
17  }
18]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[PartnerDto]

false

none

[Data transfer object representing a partner within the Nakisa Portfolio Management Suite, encapsulating essential information related to portfolio management, asset tracking, analytics, and real estate properties.]

» id

integer(int64)

false

none

Unique identifier for the resource

» status

string

false

none

Status of the resource

» displayId

string

true

none

Unique identifier for the display

» erpSystemId

integer(int64)

false

none

Unique identifier for the erp system

» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

» name

string

false

none

Name of the resource

» fax

string

false

none

Fax number associated with the partner, used for communication regarding portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.

» phone

string

false

none

Contact number for the partner associated with the portfolio, asset, or real estate property within the Nakisa Portfolio Management Suite.

» parentId

integer(int64)

false

none

Unique identifier for the parent

» parentName

string

false

none

Name of the parent

» parentDisplayId

string

false

none

Unique identifier for the parent display

» companyId

integer(int64)

false

none

Unique identifier for the company

» partnerRoleId

integer(int64)

false

none

Unique identifier for the partner role

» partnerContactId

integer(int64)

false

none

Unique identifier for the partner contact

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Partner - Search Partners

HTTP Request

POST /api/partners/search

📋 Description: Submits a search query to retrieve partner information related to portfolio assets and analytics within the Nakisa Portfolio Management Suite, enabling users to efficiently access real estate property data.

Parameters

Name

In

Type

Required

Description

body

body

PartnerDtoFilter

true

Request body containing search criteria and filters for portfolio, asset, and real estate property analytics within the Nakisa Portfolio Management Suite.

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  "erpSystemIdEqual": 0,
24  "erpSystemIdIn": [
25    0
26  ],
27  "erpSystemDisplayIdLike": "string",
28  "notIdIn": [
29    0
30  ],
31  "uiSelector": "string",
32  "nameLike": "string",
33  "faxLike": "string",
34  "phoneLike": "string",
35  "parentIdEqual": 0,
36  "parentNameEqual": "string",
37  "parentDisplayIdLike": "string",
38  "companyIdEqual": 0,
39  "companyIdIn": [
40    0
41  ],
42  "partnerRoleIdEqual": 0,
43  "partnerContactIdEqual": 0
44}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePartnerDto

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      "erpSystemId": 0,
24      "erpSystemDisplayId": "string",
25      "name": "string",
26      "fax": "string",
27      "phone": "string",
28      "parentId": 0,
29      "parentName": "string",
30      "parentDisplayId": "string",
31      "companyId": 0,
32      "partnerRoleId": 0,
33      "partnerContactId": 0
34    }
35  ],
36  "number": 0,
37  "sort": {
38    "sorted": true,
39    "unsorted": true,
40    "empty": true
41  },
42  "first": true,
43  "last": true,
44  "empty": true
45}