Site To PartnerΒΆ

Site To Partner - Get Site To PartnerΒΆ

HTTP Request

GET /api/site-to-partners/{id}

πŸ“‹ Description: Retrieves detailed information about a specific partner associated with a portfolio asset in the Nakisa Portfolio Management Suite, enabling enhanced analytics and decision-making for real estate property management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

SiteToPartnerDto

Site To Partner - Update Site To PartnerΒΆ

HTTP Request

PUT /api/site-to-partners/{id}

πŸ“‹ Description: Updates the details of a specific site-to-partner relationship within the Nakisa Portfolio Management Suite, enabling users to manage portfolio assets and enhance analytics related to real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

SiteToPartnerDto

true

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

SiteToPartnerDto

Site To Partner - Delete Site To PartnerΒΆ

HTTP Request

DELETE /api/site-to-partners/{id}

πŸ“‹ Description: Deletes a specified partner relationship from the Nakisa Portfolio Management Suite, facilitating the management of portfolio assets and enhancing 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

Site To Partner - Dissociate Or Associate Site To Partner FOS ContactΒΆ

HTTP Request

PUT /api/site-to-partners/{id}/associate-partner-contacts

πŸ“‹ Description: Associates specified partner contacts with a designated site within the Nakisa Portfolio Management Suite, enhancing collaboration and data accuracy for portfolio and asset management in real estate analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

associate

query

boolean

true

Indicates whether to associate the specified partner contacts with the given site, facilitating enhanced portfolio management and analytics within the Nakisa Portfolio Management Suite.

body

body

array[integer]

true

Request body containing the details of partner contacts to be associated with a specified site within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics in real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Site To Partner - Dissociate Or Associate Site To Partner ContactΒΆ

HTTP Request

PUT /api/site-to-partners/{id}/associate-contacts

πŸ“‹ Description: Associates specified contacts with a given partner in the Nakisa Portfolio Management Suite, enhancing the portfolio and asset management capabilities by streamlining communication and collaboration within real estate property analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

associate

query

boolean

true

Indicates whether to associate the specified contacts with the portfolio asset, facilitating enhanced analytics and management within the Nakisa Portfolio Management Suite.

body

body

array[integer]

true

Request body containing the contact association details, including identifiers and roles, necessary for linking contacts to the specified partner within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Site To Partner - Get Site To Partner ContactsΒΆ

HTTP Request

GET /api/site-to-partners/{id}/contacts

πŸ“‹ Description: Retrieves contact information for partners associated with a specific site in the Nakisa Portfolio Management Suite, facilitating enhanced asset management and analytics within the real estate portfolio.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

pageable

query

Pageable

true

Indicates whether the results of the contact retrieval for the specified partner ID should be paginated, facilitating efficient data management within the Nakisa Portfolio Management Suite.

contactTypeIds

query

array[integer]

false

Array of unique identifiers representing the types of contacts associated with the specified site-to-partner relationship within the Nakisa Portfolio Management Suite.

address

query

string

false

Specifies the address of the contact associated with the specified partner in the Nakisa Portfolio Management Suite, relevant for portfolio and asset analytics in real estate property management.

description

query

string

false

Description of the resource

email

query

string

false

Email address of the contact associated with the specified partner, used for communication and analytics within the Nakisa Portfolio Management Suite.

name

query

string

false

Name of the resource

name-like

query

string

false

Filters the contact list by matching names similar to the specified string, enhancing search efficiency within the Nakisa Portfolio Management Suite’s asset and real estate property analytics.

phone

query

string

false

Contact phone number associated with the specified partner in the Nakisa Portfolio Management Suite, facilitating effective communication regarding portfolio, asset, and real estate property management.

position

query

string

false

Specifies the position of the contact within the portfolio management framework, facilitating targeted analytics and asset management for real estate properties.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelContactDto

Site To Partner - Create Site To Partner ContactsΒΆ

HTTP Request

POST /api/site-to-partners/{id}/contacts

πŸ“‹ Description: Creates a new contact associated with a specified partner in the Nakisa Portfolio Management Suite, enhancing portfolio and asset management capabilities within the real estate property sector.

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 details for establishing connections with partners related to the specified portfolio asset.

Responses

Status

Meaning

Description

Schema

201

Created

Created

Inline

Response Schema

Status Code 201

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

Site To Partner - Archive Site To PartnerΒΆ

HTTP Request

POST /api/site-to-partners/{id}/archive

πŸ“‹ Description: Archives the specified partner associated with a portfolio asset in the Nakisa Portfolio Management Suite, enabling streamlined management and analytics 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

SiteToPartnerDto

Site To Partner - Get Site To PartnersΒΆ

HTTP Request

GET /api/site-to-partners

πŸ“‹ Description: Retrieves a list of partners associated with the specified site within the Nakisa Portfolio Management Suite, enabling users to analyze asset relationships and enhance real estate property management.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

Indicates whether the results of the site-to-partners query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset analytics within the Nakisa Portfolio Management Suite.

partner-id

query

string

false

Unique identifier for the partner associated with the portfolio, enabling retrieval of relevant asset and analytics data within the Nakisa Portfolio Management Suite.

partner-role-id

query

string

false

Unique identifier for the partner role within the Nakisa Portfolio Management Suite, facilitating the retrieval of site-to-partner associations in the context of portfolio and asset analytics.

partner-role-id-in

query

string

false

Unique identifier for the partner role within the Nakisa Portfolio Management Suite, used to filter site-to-partner relationships in the context of portfolio, asset, analytics, and real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelSiteToPartnerDto

Site To Partner - Get Unassociated Partner ContactsΒΆ

HTTP Request

GET /api/site-to-partners/{id}/unassociated-partner-contacts

πŸ“‹ Description: Retrieves a list of unassociated partner contacts for a specified site within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset management in real estate analytics.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

nameLike

query

string

false

Filter by partial match of name

typeIds

query

array[integer]

false

Array of unique identifiers for the types of partners to filter unassociated partner contacts within the Nakisa Portfolio Management Suite, relevant for portfolio, asset, analytics, and real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePartnerContactDto

Site To Partner - Get Unassociated ContactsΒΆ

HTTP Request

GET /api/site-to-partners/{id}/unassociated-contacts

πŸ“‹ Description: Fetches a list of unassociated contacts for a specified partner within the Nakisa Portfolio Management Suite, enabling users to identify potential connections for portfolio and asset management in the real estate sector.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

pageable

query

Pageable

true

Indicates whether the results should be returned in a paginated format, facilitating efficient data retrieval for unassociated contacts related to a specific asset within the Nakisa Portfolio Management Suite.

contactTypeIds

query

array[integer]

false

Array of unique identifiers for specific contact types to filter unassociated contacts related to portfolio, asset, and real estate property analytics.

address

query

string

false

Specifies the address of the real estate property to retrieve unassociated contacts related to the specified portfolio in the Nakisa Portfolio Management Suite.

description

query

string

false

Description of the resource

email

query

string

false

Email address used to filter and retrieve unassociated contacts related to a specific asset within the Nakisa Portfolio Management Suite.

name

query

string

false

Name of the resource

name-like

query

string

false

Filters the unassociated contacts by matching names that are similar to the specified string, aiding in the identification of relevant stakeholders within the portfolio management context.

phone

query

string

false

Contact phone number used to retrieve unassociated contacts related to a specific partner in the Nakisa Portfolio Management Suite.

position

query

string

false

Specifies the position within the portfolio or asset analytics context to filter unassociated contacts for the given real estate property.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelContactDto

Site To Partner - Get Site To Partner FOS ContactsΒΆ

HTTP Request

GET /api/site-to-partners/{id}/partner-contacts

πŸ“‹ Description: Retrieves partner contact information associated with a specific site within the Nakisa Portfolio Management Suite, facilitating effective communication and collaboration in portfolio and asset management.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

pageable

query

Pageable

true

Indicates whether the results of the partner contacts query should be paginated, facilitating efficient data retrieval for portfolio and asset management within the Nakisa Portfolio Management Suite.

nameLike

query

string

false

Filter by partial match of name

typeIds

query

array[integer]

false

An array of unique identifiers representing the types of partner contacts to be retrieved, relevant for portfolio, asset, analytics, and real estate property management within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePartnerContactDto

Site To Partner - Delete Site To Partner ContactΒΆ

HTTP Request

DELETE /api/site-to-partners/{siteToPartnerId}/contacts/{contactId}

πŸ“‹ Description: Deletes a specific contact associated with a site-to-partner relationship within the Nakisa Portfolio Management Suite, facilitating the management of portfolio and asset data in real estate property analytics.

Parameters

Name

In

Type

Required

Description

siteToPartnerId

path

integer(int64)

true

Unique identifier for the site to partner

contactId

path

integer(int64)

true

Unique identifier for the contact

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None