Location To PartnerΒΆ

Location To Partner - Get Location To PartnerΒΆ

HTTP Request

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

πŸ“‹ Description: Retrieves partner information associated with a specific location, enabling users to analyze relationships within their real estate portfolio and enhance asset management strategies.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

LocationToPartnerDto

Location To Partner - Update Location To PartnerΒΆ

HTTP Request

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

πŸ“‹ Description: Updates the association of a specified location with its corresponding partners within the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics for real estate properties.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

LocationToPartnerDto

true

Request body containing the updated location details for a specific partner, including relevant portfolio and asset information to enhance real estate property analytics.

Responses

Status

Meaning

Description

Schema

200

OK

OK

LocationToPartnerDto

Location To Partner - Delete Location To PartnerΒΆ

HTTP Request

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

πŸ“‹ Description: Deletes a specified location-to-partner association within the Nakisa Portfolio Management Suite, facilitating the management of portfolio and asset relationships in real estate 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

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

HTTP Request

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

πŸ“‹ Description: Associates specified partner contacts with a designated location 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 partner contacts with the specified location in the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties.

body

body

array[integer]

true

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

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

HTTP Request

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

πŸ“‹ Description: Associates specified contacts with a designated location within the Nakisa Portfolio Management Suite, enhancing portfolio and asset management capabilities for real estate properties.

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 given location in the Nakisa Portfolio Management Suite, facilitating enhanced portfolio and asset analytics for real estate properties.

body

body

array[integer]

true

Request body containing the contact details and association parameters necessary to link specified contacts to a real estate property within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Location To Partner - Get Location To Partner ContactsΒΆ

HTTP Request

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

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

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

pageable

query

Pageable

true

Indicates whether the response should be paginated, allowing users to efficiently retrieve contact information related to a specific partner within the Nakisa Portfolio Management Suite.

contactTypeIds

query

array[integer]

false

Array of unique identifiers representing the types of contacts associated with the specified location in the Nakisa Portfolio Management Suite, relevant for portfolio, asset, and real estate property analytics.

address

query

string

false

Specifies the address associated with the contacts of a partner in the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics within 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 in the Nakisa Portfolio Management Suite, facilitating communication within the context of portfolio and asset management.

name

query

string

false

Name of the resource

name-like

query

string

false

Filters the list of contacts associated with the specified partner by matching the provided string against their names, enhancing asset and portfolio analytics within the Nakisa Portfolio Management Suite.

phone

query

string

false

Contact phone number associated with the specified partner in the Nakisa Portfolio Management Suite, relevant for portfolio and asset management communications.

position

query

string

false

Specifies the position within the contact list of partners associated with a particular asset in the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelContactDto

Location To Partner - Create Location To Partner ContactsΒΆ

HTTP Request

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

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

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 partners associated with a specific location, facilitating effective portfolio management and asset analytics.

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

Location To Partner - Archive Location To PartnerΒΆ

HTTP Request

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

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

LocationToPartnerDto

Location To Partner - Get Location To PartnersΒΆ

HTTP Request

GET /api/location-to-partners

πŸ“‹ Description: Retrieves a list of partners associated with specific locations 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

pageable

query

Pageable

true

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

partner-id

query

string

false

Unique identifier for the partner associated with a specific location, facilitating effective portfolio and asset management within the Nakisa Portfolio Management Suite.

partner-role-id

query

string

false

Unique identifier for the partner role, used to filter and retrieve specific partner-related data within the Nakisa Portfolio Management Suite.

partner-role-id-in

query

string

false

Unique identifier for the partner role, used to filter results in the location-to-partners API endpoint within the Nakisa Portfolio Management Suite, relevant for portfolio, asset, analytics, and real estate property management.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelLocationToPartnerDto

Location To Partner - Get Unassociated Partner ContactsΒΆ

HTTP Request

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

πŸ“‹ Description: Retrieves a list of unassociated partner contacts for a specified location 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

An array of unique identifiers for specific types of partners, used to filter unassociated partner contacts related to the specified location within the Nakisa Portfolio Management Suite.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagePartnerContactDto

Location To Partner - Get Unassociated ContactsΒΆ

HTTP Request

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

πŸ“‹ Description: Fetches unassociated contacts linked to a specific partner location, facilitating enhanced 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

pageable

query

Pageable

true

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

contactTypeIds

query

array[integer]

false

Array of unique identifiers representing the types of contacts to be retrieved that are not currently associated with the specified location in the Nakisa Portfolio Management Suite.

address

query

string

false

Specifies the address associated with the unassociated contacts for the given partner ID within the Nakisa Portfolio Management Suite, facilitating accurate portfolio and asset analytics in real estate property management.

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 partner within the Nakisa Portfolio Management Suite.

name

query

string

false

Name of the resource

name-like

query

string

false

Filters the list of unassociated contacts by matching names that are similar to the specified string, facilitating targeted analytics within the Nakisa Portfolio Management Suite.

phone

query

string

false

Represents the phone number of unassociated contacts related to a specific location within the Nakisa Portfolio Management Suite, facilitating efficient communication in portfolio and asset management.

position

query

string

false

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

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelContactDto

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

HTTP Request

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

πŸ“‹ Description: Retrieves partner contact information associated with a specific location within the Nakisa Portfolio Management Suite, facilitating enhanced 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 response should be paginated, facilitating efficient retrieval of partner contact information related to a specific location 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 for the types of partner contacts to retrieve, 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

Location To Partner - Delete Location To Partner ContactΒΆ

HTTP Request

DELETE /api/location-to-partners/{locationToPartnerId}/contacts/{contactId}

πŸ“‹ Description: Deletes a specific contact associated with a location-to-partner relationship within the Nakisa Portfolio Management Suite, facilitating streamlined management of portfolio and asset-related communications.

Parameters

Name

In

Type

Required

Description

locationToPartnerId

path

integer(int64)

true

Unique identifier for the location to partner

contactId

path

integer(int64)

true

Unique identifier for the contact

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None