Proposal Contact

Proposal Contact - Get Proposal Contact

HTTP Request

GET /api/proposal-contacts/{id}

📋 Description: Retrieves detailed information about a specific proposal contact by its unique identifier, facilitating effective management and analysis of portfolio-related assets 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

ProposalContactDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "title": "string",
10  "company": "string",
11  "firstName": "string",
12  "lastName": "string",
13  "email": "string",
14  "phone": "string",
15  "cell": "string",
16  "address": "string",
17  "ownership": "string",
18  "entity": "string",
19  "proposal": {
20    "createdBy": "string",
21    "lastModifiedBy": "string",
22    "createdDate": "2019-08-24T14:15:22Z",
23    "lastModifiedDate": "2019-08-24T14:15:22Z",
24    "archived": true,
25    "externalId": "string",
26    "id": 0,
27    "receivedDate": "2019-08-24",
28    "receivedViaId": 0,
29    "followUpDate": "2019-08-24",
30    "proposalStatusId": 0,
31    "siteName": "string",
32    "siteCivicNumber": "string",
33    "siteStreet": "string",
34    "siteSuite": "string",
35    "sitePostalCode": "string",
36    "siteLon": 0.1,
37    "siteLat": 0.1,
38    "siteLot": "string",
39    "siteNearbyAddress": "string",
40    "siteNearby": "string",
41    "addressTrafficTypeId": 0,
42    "siteCityId": 0,
43    "siteDistrictId": 0,
44    "evaluatedById": 0,
45    "evaluatedMailViaId": 0,
46    "progressStatusId": 0,
47    "evaluatedDate": "string",
48    "evaluatedComment": "string",
49    "premiseId": 0
50  },
51  "proposalId": 0
52}

Proposal Contact - Update Proposal Contact

HTTP Request

PUT /api/proposal-contacts/{id}

📋 Description: Updates the contact information for a specified proposal within the Nakisa Portfolio Management Suite, enabling accurate management of portfolio and asset-related communications in the real estate sector.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

ProposalContactDto

true

Request body containing the updated contact information for a proposal, including details such as name, role, and contact methods, essential for effective portfolio and asset management within the Nakisa Portfolio Management Suite.

Body Parameters

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "title": "string",
10  "company": "string",
11  "firstName": "string",
12  "lastName": "string",
13  "email": "string",
14  "phone": "string",
15  "cell": "string",
16  "address": "string",
17  "ownership": "string",
18  "entity": "string",
19  "proposal": {
20    "createdBy": "string",
21    "lastModifiedBy": "string",
22    "createdDate": "2019-08-24T14:15:22Z",
23    "lastModifiedDate": "2019-08-24T14:15:22Z",
24    "archived": true,
25    "externalId": "string",
26    "id": 0,
27    "receivedDate": "2019-08-24",
28    "receivedViaId": 0,
29    "followUpDate": "2019-08-24",
30    "proposalStatusId": 0,
31    "siteName": "string",
32    "siteCivicNumber": "string",
33    "siteStreet": "string",
34    "siteSuite": "string",
35    "sitePostalCode": "string",
36    "siteLon": 0.1,
37    "siteLat": 0.1,
38    "siteLot": "string",
39    "siteNearbyAddress": "string",
40    "siteNearby": "string",
41    "addressTrafficTypeId": 0,
42    "siteCityId": 0,
43    "siteDistrictId": 0,
44    "evaluatedById": 0,
45    "evaluatedMailViaId": 0,
46    "progressStatusId": 0,
47    "evaluatedDate": "string",
48    "evaluatedComment": "string",
49    "premiseId": 0
50  },
51  "proposalId": 0
52}

Responses

Status

Meaning

Description

Schema

200

OK

OK

None

Proposal Contact - Delete Proposal Contact

HTTP Request

DELETE /api/proposal-contacts/{id}

📋 Description: Deletes a specified proposal contact from the Nakisa Portfolio Management Suite, ensuring that your portfolio and asset management data remains accurate and up-to-date.

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

Proposal Contact - Create Proposal Contact

HTTP Request

POST /api/proposal-contacts

📋 Description: Creates a new proposal contact within the Nakisa Portfolio Management Suite, enabling users to effectively manage and analyze stakeholder relationships related to portfolio and asset activities in real estate properties.

Parameters

Name

In

Type

Required

Description

body

body

ProposalContactDto

true

Request body containing the proposal contact details, including name, role, and associated portfolio information, essential for managing asset and real estate property analytics.

Body Parameters

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "title": "string",
10  "company": "string",
11  "firstName": "string",
12  "lastName": "string",
13  "email": "string",
14  "phone": "string",
15  "cell": "string",
16  "address": "string",
17  "ownership": "string",
18  "entity": "string",
19  "proposal": {
20    "createdBy": "string",
21    "lastModifiedBy": "string",
22    "createdDate": "2019-08-24T14:15:22Z",
23    "lastModifiedDate": "2019-08-24T14:15:22Z",
24    "archived": true,
25    "externalId": "string",
26    "id": 0,
27    "receivedDate": "2019-08-24",
28    "receivedViaId": 0,
29    "followUpDate": "2019-08-24",
30    "proposalStatusId": 0,
31    "siteName": "string",
32    "siteCivicNumber": "string",
33    "siteStreet": "string",
34    "siteSuite": "string",
35    "sitePostalCode": "string",
36    "siteLon": 0.1,
37    "siteLat": 0.1,
38    "siteLot": "string",
39    "siteNearbyAddress": "string",
40    "siteNearby": "string",
41    "addressTrafficTypeId": 0,
42    "siteCityId": 0,
43    "siteDistrictId": 0,
44    "evaluatedById": 0,
45    "evaluatedMailViaId": 0,
46    "progressStatusId": 0,
47    "evaluatedDate": "string",
48    "evaluatedComment": "string",
49    "premiseId": 0
50  },
51  "proposalId": 0
52}

Responses

Status

Meaning

Description

Schema

201

Created

Created

integer

Example Responses

10

Proposal Contact - Get Proposal Contacts By Proposal And Entity

HTTP Request

GET /api/proposal-contacts/proposal/{proposalId}/entity/{entity}

📋 Description: Fetches the contact details associated with a specific proposal and entity within the Nakisa Portfolio Management Suite, facilitating effective management of portfolio and asset-related communications.

Parameters

Name

In

Type

Required

Description

proposalId

path

integer(int64)

true

Unique identifier for the proposal

entity

path

string

true

Specifies the type of entity related to the proposal, which can include portfolio, asset, analytics, or real estate property, to retrieve relevant contact information.

Responses

Status

Meaning

Description

Schema

200

OK

OK

Inline

Example Responses

 1[
 2  {
 3    "createdBy": "string",
 4    "lastModifiedBy": "string",
 5    "createdDate": "2019-08-24T14:15:22Z",
 6    "lastModifiedDate": "2019-08-24T14:15:22Z",
 7    "archived": true,
 8    "externalId": "string",
 9    "id": 0,
10    "title": "string",
11    "company": "string",
12    "firstName": "string",
13    "lastName": "string",
14    "email": "string",
15    "phone": "string",
16    "cell": "string",
17    "address": "string",
18    "ownership": "string",
19    "entity": "string",
20    "proposal": {
21      "createdBy": "string",
22      "lastModifiedBy": "string",
23      "createdDate": "2019-08-24T14:15:22Z",
24      "lastModifiedDate": "2019-08-24T14:15:22Z",
25      "archived": true,
26      "externalId": "string",
27      "id": 0,
28      "receivedDate": "2019-08-24",
29      "receivedViaId": 0,
30      "followUpDate": "2019-08-24",
31      "proposalStatusId": 0,
32      "siteName": "string",
33      "siteCivicNumber": "string",
34      "siteStreet": "string",
35      "siteSuite": "string",
36      "sitePostalCode": "string",
37      "siteLon": 0.1,
38      "siteLat": 0.1,
39      "siteLot": "string",
40      "siteNearbyAddress": "string",
41      "siteNearby": "string",
42      "addressTrafficTypeId": 0,
43      "siteCityId": 0,
44      "siteDistrictId": 0,
45      "evaluatedById": 0,
46      "evaluatedMailViaId": 0,
47      "progressStatusId": 0,
48      "evaluatedDate": "string",
49      "evaluatedComment": "string",
50      "premiseId": 0
51    },
52    "proposalId": 0
53  }
54]

Response Schema

Status Code 200

Name

Type

Required

Restrictions

Description

anonymous

[ProposalContactDto]

false

none

[Data transfer object representing a contact associated with a proposal in the Nakisa Portfolio Management Suite, facilitating communication and collaboration within the context of portfolio management, asset analytics, and real estate property transactions.]

» createdBy

string

false

none

Username of who created this resource

» lastModifiedBy

string

false

none

Username of who last modified this resource

» createdDate

string(date-time)

false

none

Date of the created

» lastModifiedDate

string(date-time)

false

none

Date of the last modified

» archived

boolean

false

none

Boolean flag indicating archived status

» externalId

string

false

none

Unique identifier for the external

» id

integer(int64)

false

none

Unique identifier for the resource

» title

string

false

none

Title of the resource

» company

string

false

none

Name of the company associated with the proposal contact, relevant for portfolio and asset management within the Nakisa Portfolio Management Suite.

» firstName

string

false

none

Name of the first

» lastName

string

false

none

Name of the last

» email

string

false

none

Email address of the primary contact for the proposal, facilitating communication regarding portfolio, asset, and real estate property analytics.

» phone

string

false

none

Contact phone number for the individual associated with the proposal, facilitating communication regarding portfolio, asset, and real estate property analytics.

» cell

string

false

none

Represents the contact’s cell phone number associated with the proposal, facilitating communication within the context of portfolio and asset management in real estate analytics.

» address

string

false

none

Represents the physical location of the contact associated with a proposal, essential for portfolio and asset management within the Nakisa Portfolio Management Suite.

» ownership

string

false

none

Indicates the ownership status of the asset within the portfolio, providing essential insights for analytics and real estate property management.

» entity

string

false

none

Represents the specific entity associated with a proposal contact, facilitating effective management and analysis within the Nakisa Portfolio Management Suite’s portfolio, asset, and real estate property domains.

» proposal

Proposal

false

none

Data transfer object representing a proposal within the Nakisa Portfolio Management Suite, encompassing critical details related to portfolio management, asset allocation, and analytics for real estate properties.

»» createdBy

string

false

none

Username of who created this resource

»» lastModifiedBy

string

false

none

Username of who last modified this resource

»» createdDate

string(date-time)

false

none

Date of the created

»» lastModifiedDate

string(date-time)

false

none

Date of the last modified

»» archived

boolean

false

none

Boolean flag indicating archived status

»» externalId

string

false

none

Unique identifier for the external

»» id

integer(int64)

false

none

Unique identifier for the resource

»» receivedDate

string(date)

false

none

Date of the received

»» receivedViaId

integer(int64)

false

none

Unique identifier for the received via

»» followUpDate

string(date)

false

none

Date of the follow up

»» proposalStatusId

integer(int64)

false

none

Unique identifier for the proposal status

»» siteName

string

false

none

Name of the site

»» siteCivicNumber

string

false

none

Represents the civic number associated with a real estate property within the portfolio management proposal, facilitating accurate asset identification and analytics.

»» siteStreet

string

false

none

Represents the street address of the real estate property within the proposal, facilitating accurate portfolio and asset management analytics.

»» siteSuite

string

false

none

Represents the designated site suite associated with a proposal, facilitating effective management and analysis of real estate assets within the Nakisa Portfolio Management Suite.

»» sitePostalCode

string

false

none

Code for the site postal

»» siteLon

number(double)

false

none

Value for siteLon field

»» siteLat

number(double)

false

none

Value for siteLat field

»» siteLot

string

false

none

The siteLot field represents the designated lot or parcel associated with a real estate property within the portfolio, facilitating asset management and analytics in the Nakisa Portfolio Management Suite.

»» siteNearbyAddress

string

false

none

Represents the address of a nearby site relevant to the proposal, facilitating enhanced asset analysis and portfolio management within the Nakisa Portfolio Management Suite.

»» siteNearby

string

false

none

Indicates the proximity of the asset to nearby sites, facilitating enhanced portfolio analytics and informed decision-making in real estate property management.

»» addressTrafficTypeId

integer(int64)

false

none

Unique identifier for the address traffic type

»» siteCityId

integer(int64)

false

none

Unique identifier for the site city

»» siteDistrictId

integer(int64)

false

none

Unique identifier for the site district

»» evaluatedById

integer(int64)

false

none

Unique identifier for the evaluated by

»» evaluatedMailViaId

integer(int64)

false

none

Unique identifier for the evaluated mail via

»» progressStatusId

integer(int64)

false

none

Unique identifier for the progress status

»» evaluatedDate

string

false

none

Date of the evaluated

»» evaluatedComment

string

false

none

Textual evaluation of the proposal, providing insights and analytics related to portfolio and asset performance within the Nakisa Portfolio Management Suite.

»» premiseId

integer(int64)

false

none

Unique identifier for the premise

» proposalId

integer(int64)

false

none

Unique identifier for the proposal