Master Agreement Partner

Master Agreement Partner - Get Master Agreement Partner

HTTP Request

GET /api/master-agreement-partners/{id}

📋 Description: Retrieves detailed information about a specific master agreement partner by its unique identifier, facilitating insights into portfolio and asset management within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

MasterAgreementPartnerDto

Example Responses

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "partner": {
 5    "id": 0,
 6    "displayId": "string",
 7    "status": "CREATED",
 8    "name": "string",
 9    "erpSystemDisplayId": "string"
10  },
11  "partnerRole": {
12    "id": 0,
13    "displayId": "string",
14    "status": "CREATED",
15    "name": "string"
16  },
17  "masterAgreementId": 0,
18  "masterAgreementDisplayId": "string",
19  "numberRangeIdentifierType": {
20    "name": "string"
21  },
22  "numberRangeIdentifierValue": "string",
23  "allowsSystemGenerateNewId": true,
24  "numberRangeType": {
25    "name": "string"
26  }
27}

Master Agreement Partner - Update Master Agreement Partner

HTTP Request

PUT /api/master-agreement-partners/{id}

📋 Description: Updates the details of a specified master agreement partner within the Nakisa Portfolio Management Suite, enabling accurate management of portfolio, asset, and real estate property data.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

MasterAgreementPartnerDto

true

Request body containing updated master agreement partner details, including relevant portfolio, asset, and analytics information for real estate property management.

Body Parameters

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "partner": {
 5    "id": 0,
 6    "displayId": "string",
 7    "status": "CREATED",
 8    "name": "string",
 9    "erpSystemDisplayId": "string"
10  },
11  "partnerRole": {
12    "id": 0,
13    "displayId": "string",
14    "status": "CREATED",
15    "name": "string"
16  },
17  "masterAgreementId": 0,
18  "masterAgreementDisplayId": "string",
19  "numberRangeIdentifierType": {
20    "name": "string"
21  },
22  "numberRangeIdentifierValue": "string",
23  "allowsSystemGenerateNewId": true,
24  "numberRangeType": {
25    "name": "string"
26  }
27}

Responses

Status

Meaning

Description

Schema

200

OK

OK

MasterAgreementPartnerDto

Example Responses

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "partner": {
 5    "id": 0,
 6    "displayId": "string",
 7    "status": "CREATED",
 8    "name": "string",
 9    "erpSystemDisplayId": "string"
10  },
11  "partnerRole": {
12    "id": 0,
13    "displayId": "string",
14    "status": "CREATED",
15    "name": "string"
16  },
17  "masterAgreementId": 0,
18  "masterAgreementDisplayId": "string",
19  "numberRangeIdentifierType": {
20    "name": "string"
21  },
22  "numberRangeIdentifierValue": "string",
23  "allowsSystemGenerateNewId": true,
24  "numberRangeType": {
25    "name": "string"
26  }
27}

Master Agreement Partner - Delete Master Agreement Partner

HTTP Request

DELETE /api/master-agreement-partners/{id}

📋 Description: Deletes a specified master agreement partner from the Nakisa Portfolio Management Suite, ensuring accurate portfolio and asset management within 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

No Content

None

Master Agreement Partner - Create Master Agreement Partner

HTTP Request

POST /api/master-agreement-partners

📋 Description: Creates a new master agreement partner within the Nakisa Portfolio Management Suite, enabling enhanced management of portfolio assets and analytics related to real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

MasterAgreementPartnerDto

true

Request body containing the master agreement partner details, including portfolio associations and relevant asset analytics for real estate property management.

Body Parameters

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "partner": {
 5    "id": 0,
 6    "displayId": "string",
 7    "status": "CREATED",
 8    "name": "string",
 9    "erpSystemDisplayId": "string"
10  },
11  "partnerRole": {
12    "id": 0,
13    "displayId": "string",
14    "status": "CREATED",
15    "name": "string"
16  },
17  "masterAgreementId": 0,
18  "masterAgreementDisplayId": "string",
19  "numberRangeIdentifierType": {
20    "name": "string"
21  },
22  "numberRangeIdentifierValue": "string",
23  "allowsSystemGenerateNewId": true,
24  "numberRangeType": {
25    "name": "string"
26  }
27}

Responses

Status

Meaning

Description

Schema

201

Created

Created

MasterAgreementPartnerDto

Example Responses

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "partner": {
 5    "id": 0,
 6    "displayId": "string",
 7    "status": "CREATED",
 8    "name": "string",
 9    "erpSystemDisplayId": "string"
10  },
11  "partnerRole": {
12    "id": 0,
13    "displayId": "string",
14    "status": "CREATED",
15    "name": "string"
16  },
17  "masterAgreementId": 0,
18  "masterAgreementDisplayId": "string",
19  "numberRangeIdentifierType": {
20    "name": "string"
21  },
22  "numberRangeIdentifierValue": "string",
23  "allowsSystemGenerateNewId": true,
24  "numberRangeType": {
25    "name": "string"
26  }
27}

Master Agreement Partner - Get Master Agreement Partner Contacts

HTTP Request

GET /api/master-agreement-partners/{id}/contacts

📋 Description: Fetches the list of contacts associated with a specified master agreement partner, enabling users to manage and analyze stakeholder relationships within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "displayId": "string",
 5    "name": "string",
 6    "position": "string",
 7    "email": "string",
 8    "phone": "string",
 9    "address": "string",
10    "description": "string",
11    "group": "string",
12    "buildingName": "string",
13    "fax": "string",
14    "numberRangeIdentifierType": {
15      "name": "string"
16    },
17    "numberRangeIdentifierValue": "string",
18    "allowsSystemGenerateNewId": true,
19    "numberRangeType": {
20      "name": "string"
21    }
22  }
23]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[ContactDto]

false

none

[Data transfer object representing a contact within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio, asset, analytics, and real estate property management.]

» id

integer(int64)

false

none

Unique identifier for the resource

» displayId

string

false

none

Unique identifier for the display

» name

string

true

none

Name of the resource

» position

string

false

none

Represents the specific role or title of a contact within the context of portfolio management, asset analytics, and real estate property management.

» email

string

true

none

Email address of the contact associated with the portfolio, asset, or real estate property, facilitating communication and analytics within the Nakisa Portfolio Management Suite.

» phone

string

false

none

Represents the contact phone number associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating communication and management of portfolio assets.

» address

string

false

none

Represents the physical location of a real estate property within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics.

» description

string

false

none

Description of the resource

» group

string

false

none

Represents the classification of a contact within the Nakisa Portfolio Management Suite, facilitating effective organization and analysis of portfolios, assets, and real estate properties.

» buildingName

string

false

none

Name of the building

» fax

string

false

none

Fax number associated with the contact, used for communication purposes within the Nakisa Portfolio Management Suite, particularly in the context of portfolio, asset, and real estate property management.

» numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics.

»» name

string

false

none

Name of the resource

» numberRangeIdentifierValue

string

false

none

String value representing the unique identifier for a specific number range associated with portfolio assets and analytics within the Nakisa Portfolio Management Suite.

» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

» numberRangeType

INumberRangeType

false

none

Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics.

»» name

string

true

none

Name of the resource

Master Agreement Partner - Post Master Agreement Partner Contact

HTTP Request

POST /api/master-agreement-partners/{id}/contacts

📋 Description: Creates a new contact associated with the specified master agreement partner, enhancing portfolio management and asset analytics within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ContactDto

true

Request body containing the contact information and associated details for the specified master agreement partner, essential for managing portfolio and asset relationships within the Nakisa Portfolio Management Suite.

Body Parameters

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "name": "string",
 5  "position": "string",
 6  "email": "string",
 7  "phone": "string",
 8  "address": "string",
 9  "description": "string",
10  "group": "string",
11  "buildingName": "string",
12  "fax": "string",
13  "numberRangeIdentifierType": {
14    "name": "string"
15  },
16  "numberRangeIdentifierValue": "string",
17  "allowsSystemGenerateNewId": true,
18  "numberRangeType": {
19    "name": "string"
20  }
21}

Responses

Status

Meaning

Description

Schema

200

OK

OK

ContactDto

Example Responses

 1{
 2  "id": 0,
 3  "displayId": "string",
 4  "name": "string",
 5  "position": "string",
 6  "email": "string",
 7  "phone": "string",
 8  "address": "string",
 9  "description": "string",
10  "group": "string",
11  "buildingName": "string",
12  "fax": "string",
13  "numberRangeIdentifierType": {
14    "name": "string"
15  },
16  "numberRangeIdentifierValue": "string",
17  "allowsSystemGenerateNewId": true,
18  "numberRangeType": {
19    "name": "string"
20  }
21}

Master Agreement Partner - Post Master Agreement Partner Contacts

HTTP Request

POST /api/master-agreement-partners/{id}/contacts/bulk

📋 Description: Uploads multiple contact records in bulk for a specified master agreement partner, facilitating efficient management of portfolio-related contacts within the Nakisa Portfolio Management Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ContactDto

true

Request body containing an array of contact information for bulk addition to the specified master agreement partner, facilitating enhanced portfolio management and asset analytics within the Nakisa Portfolio Management Suite.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "displayId": "string",
 5    "name": "string",
 6    "position": "string",
 7    "email": "string",
 8    "phone": "string",
 9    "address": "string",
10    "description": "string",
11    "group": "string",
12    "buildingName": "string",
13    "fax": "string",
14    "numberRangeIdentifierType": {
15      "name": "string"
16    },
17    "numberRangeIdentifierValue": "string",
18    "allowsSystemGenerateNewId": true,
19    "numberRangeType": {
20      "name": "string"
21    }
22  }
23]

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "displayId": "string",
 5    "name": "string",
 6    "position": "string",
 7    "email": "string",
 8    "phone": "string",
 9    "address": "string",
10    "description": "string",
11    "group": "string",
12    "buildingName": "string",
13    "fax": "string",
14    "numberRangeIdentifierType": {
15      "name": "string"
16    },
17    "numberRangeIdentifierValue": "string",
18    "allowsSystemGenerateNewId": true,
19    "numberRangeType": {
20      "name": "string"
21    }
22  }
23]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[ContactDto]

false

none

[Data transfer object representing a contact within the Nakisa Portfolio Management Suite, encompassing essential details related to portfolio, asset, analytics, and real estate property management.]

» id

integer(int64)

false

none

Unique identifier for the resource

» displayId

string

false

none

Unique identifier for the display

» name

string

true

none

Name of the resource

» position

string

false

none

Represents the specific role or title of a contact within the context of portfolio management, asset analytics, and real estate property management.

» email

string

true

none

Email address of the contact associated with the portfolio, asset, or real estate property, facilitating communication and analytics within the Nakisa Portfolio Management Suite.

» phone

string

false

none

Represents the contact phone number associated with a real estate property within the Nakisa Portfolio Management Suite, facilitating communication and management of portfolio assets.

» address

string

false

none

Represents the physical location of a real estate property within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics.

» description

string

false

none

Description of the resource

» group

string

false

none

Represents the classification of a contact within the Nakisa Portfolio Management Suite, facilitating effective organization and analysis of portfolios, assets, and real estate properties.

» buildingName

string

false

none

Name of the building

» fax

string

false

none

Fax number associated with the contact, used for communication purposes within the Nakisa Portfolio Management Suite, particularly in the context of portfolio, asset, and real estate property management.

» numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics.

»» name

string

false

none

Name of the resource

» numberRangeIdentifierValue

string

false

none

String value representing the unique identifier for a specific number range associated with portfolio assets and analytics within the Nakisa Portfolio Management Suite.

» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

» numberRangeType

INumberRangeType

false

none

Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics.

»» name

string

true

none

Name of the resource

Master Agreement Partner - Search Master Agreement Partners

HTTP Request

POST /api/master-agreement-partners/search

📋 Description: Submits a search request for master agreement partners within the Nakisa Portfolio Management Suite, enabling users to efficiently identify and analyze relevant partnerships related to portfolio and asset management in the real estate sector.

Parameters

Name

In

Type

Required

Description

body

body

MasterAgreementPartnerDtoFilter

true

Request body containing search criteria and filters for identifying master agreement partners relevant to portfolio management, asset analytics, and real estate properties.

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  "displayIdIn": [
16    "string"
17  ],
18  "displayIdLike": "string",
19  "partnerIdIn": [
20    0
21  ],
22  "partnerDisplayIdIn": [
23    "string"
24  ],
25  "partnerRoleIdIn": [
26    0
27  ],
28  "partnerRoleDisplayIdIn": [
29    "string"
30  ],
31  "masterAgreementIdIn": [
32    0
33  ],
34  "masterAgreementDisplayIdIn": [
35    "string"
36  ]
37}

Responses

Status

Meaning

Description

Schema

200

OK

OK

PageMasterAgreementPartnerDto

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      "displayId": "string",
22      "partner": {
23        "id": 0,
24        "displayId": "string",
25        "status": "CREATED",
26        "name": "string",
27        "erpSystemDisplayId": "string"
28      },
29      "partnerRole": {
30        "id": 0,
31        "displayId": "string",
32        "status": "CREATED",
33        "name": "string"
34      },
35      "masterAgreementId": 0,
36      "masterAgreementDisplayId": "string",
37      "numberRangeIdentifierType": {
38        "name": "string"
39      },
40      "numberRangeIdentifierValue": "string",
41      "allowsSystemGenerateNewId": true,
42      "numberRangeType": {
43        "name": "string"
44      }
45    }
46  ],
47  "number": 0,
48  "sort": {
49    "sorted": true,
50    "unsorted": true,
51    "empty": true
52  },
53  "first": true,
54  "last": true,
55  "empty": true
56}

Master Agreement Partner - Create Master Agreement Partners

HTTP Request

POST /api/master-agreement-partners/bulk

📋 Description: Submits a bulk upload of master agreement partner data to the Nakisa Portfolio Management Suite, enabling efficient management and analysis of portfolio assets within real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

MasterAgreementPartnerDto

true

Request body containing a collection of master agreement partner details, including portfolio identifiers and asset information, for bulk processing within the Nakisa Portfolio Management Suite.

Body Parameters

 1[
 2  {
 3    "id": 0,
 4    "displayId": "string",
 5    "partner": {
 6      "id": 0,
 7      "displayId": "string",
 8      "status": "CREATED",
 9      "name": "string",
10      "erpSystemDisplayId": "string"
11    },
12    "partnerRole": {
13      "id": 0,
14      "displayId": "string",
15      "status": "CREATED",
16      "name": "string"
17    },
18    "masterAgreementId": 0,
19    "masterAgreementDisplayId": "string",
20    "numberRangeIdentifierType": {
21      "name": "string"
22    },
23    "numberRangeIdentifierValue": "string",
24    "allowsSystemGenerateNewId": true,
25    "numberRangeType": {
26      "name": "string"
27    }
28  }
29]

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Example Responses

 1[
 2  {
 3    "id": 0,
 4    "displayId": "string",
 5    "partner": {
 6      "id": 0,
 7      "displayId": "string",
 8      "status": "CREATED",
 9      "name": "string",
10      "erpSystemDisplayId": "string"
11    },
12    "partnerRole": {
13      "id": 0,
14      "displayId": "string",
15      "status": "CREATED",
16      "name": "string"
17    },
18    "masterAgreementId": 0,
19    "masterAgreementDisplayId": "string",
20    "numberRangeIdentifierType": {
21      "name": "string"
22    },
23    "numberRangeIdentifierValue": "string",
24    "allowsSystemGenerateNewId": true,
25    "numberRangeType": {
26      "name": "string"
27    }
28  }
29]

Response Schema

Status Code 201

Name

Type

Required

Restrictions

Description

anonymous

[MasterAgreementPartnerDto]

false

none

[Data transfer object representing a master agreement partner within the Nakisa Portfolio Management Suite, encapsulating essential details for managing portfolio assets and analytics related to real estate properties.]

» id

integer(int64)

false

none

Unique identifier for the resource

» displayId

string

false

none

Unique identifier for the display

» partner

PartnerLite

false

none

Data transfer object representing a streamlined partner profile within the Nakisa Portfolio Management Suite, encompassing essential details for portfolio, asset, and analytics management in the real estate property sector.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» displayId

string

false

none

Unique identifier for the display

»» status

string

false

none

Status of the resource

»» name

string

false

none

Name of the resource

»» erpSystemDisplayId

string

false

none

Unique identifier for the erp system display

» partnerRole

PartnerRoleLite

false

none

Data transfer object representing a simplified view of a partner’s role within the Nakisa Portfolio Management Suite, facilitating insights into portfolio, asset, and real estate property analytics.

»» id

integer(int64)

false

none

Unique identifier for the resource

»» displayId

string

false

none

Unique identifier for the display

»» status

string

false

none

Status of the resource

»» name

string

false

none

Name of the resource

» masterAgreementId

integer(int64)

false

none

Unique identifier for the master agreement

» masterAgreementDisplayId

string

false

none

Unique identifier for the master agreement display

» numberRangeIdentifierType

INumberRangeIdentifierType

false

none

Data transfer object representing a numerical range identifier used for categorizing and analyzing assets within the Nakisa Portfolio Management Suite, specifically in the context of portfolio management, asset tracking, and real estate property analytics.

»» name

string

false

none

Name of the resource

» numberRangeIdentifierValue

string

false

none

Unique string identifier representing a specific range of numbers associated with assets within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in the real estate property domain.

» allowsSystemGenerateNewId

boolean

false

none

Unique identifier for the allows system generate new

» numberRangeType

INumberRangeType

false

none

Data transfer object representing a numerical range utilized in the Nakisa Portfolio Management Suite, specifically designed for portfolio and asset analytics within the real estate property domain. This schema facilitates precise data representation and analysis of asset values and performance metrics.

»» name

string

true

none

Name of the resource

Enumerated Values

Attribute

Value

status

ACTIVE, CREATED, DECOMMISSIONED, DISABLED

Master Agreement Partner - Delete Master Agreement Partner Contact

HTTP Request

DELETE /api/master-agreement-partners/{id}/contacts/{contactId}

📋 Description: Deletes a specified contact associated with a master agreement partner within the Nakisa Portfolio Management Suite, ensuring accurate management of portfolio-related data and enhancing asset analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

contactId

path

integer(int64)

true

Unique identifier for the contact

Responses

Status

Meaning

Description

Schema

200

OK

OK

None