Partner Role

Create Partner Roles

HTTP Request

POST /api/partner-roles

📋 Description: Creates a new partner role within the Nakisa Portfolio Management Suite, enabling enhanced collaboration and analytics for managing real estate property assets.

Parameters

Name

In

Type

Required

Description

body

body

PartnerRoleDto

true

Request body containing the partner role details, including role attributes and associated portfolio analytics for effective asset management within the Nakisa Portfolio Management Suite.

Body Parameters

1[
2  {
3    "id": 0,
4    "status": "CREATED",
5    "displayId": "string",
6    "name": "string",
7    "partnerId": 0
8  }
9]

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Example Responses

1[
2  {
3    "id": 0,
4    "status": "CREATED",
5    "displayId": "string",
6    "name": "string",
7    "partnerId": 0
8  }
9]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[PartnerRoleDto]

false

none

[Data transfer object representing the roles and responsibilities of partners within the Nakisa Portfolio Management Suite, facilitating effective collaboration in portfolio, asset, and real estate property analytics.]

» 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

» name

string

false

none

Name of the resource

» partnerId

integer(int64)

false

none

Unique identifier for the partner

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Search Partner Roles

HTTP Request

POST /api/partner-roles/search

📋 Description: Submits a search request for partner roles within the Nakisa Portfolio Management Suite, enabling users to efficiently identify and analyze relevant roles associated with portfolio, asset, and real estate property management.

Parameters

Name

In

Type

Required

Description

body

body

PartnerRoleDtoFilter

true

Request body containing search criteria and filters for identifying partner 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  "partnerIdEqual": 0
28}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePartnerRoleDto

Example Responses

 1{
 2  "totalElements": 0,
 3  "totalPages": 0,
 4  "pageable": {
 5    "paged": true,
 6    "unpaged": true,
 7    "pageNumber": 0,
 8    "pageSize": 0,
 9    "offset": 0,
10    "sort": {
11      "unsorted": true,
12      "sorted": 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      "partnerId": 0
25    }
26  ],
27  "number": 0,
28  "sort": {
29    "unsorted": true,
30    "sorted": true,
31    "empty": true
32  },
33  "first": true,
34  "last": true,
35  "empty": true
36}

Get Partner Role

HTTP Request

GET /api/partners-roles/{id}

📋 Description: Retrieves detailed information about a specific partner role within the Nakisa Portfolio Management Suite, facilitating insights into portfolio management, asset allocation, 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

200

OK

OK

PartnerRoleDto

Example Responses

1{
2  "id": 0,
3  "status": "CREATED",
4  "displayId": "string",
5  "name": "string",
6  "partnerId": 0
7}

Delete Partner Role

HTTP Request

DELETE /api/partner-roles/{id}

📋 Description: Deletes a specified partner role from the Nakisa Portfolio Management Suite, ensuring the integrity of portfolio and asset management by removing outdated or unnecessary role assignments.

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