Contact

Contact - Get Contact

HTTP Request

GET /api/contacts/{id}

Interactive Demo

📋 Description: Retrieves detailed information about a specific contact within the Nakisa Portfolio Management Suite, facilitating effective management of portfolio assets and 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	ContactDto

Example Responses

{
  "id": 0,
  "displayId": "string",
  "name": "string",
  "position": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "description": "string",
  "group": "string",
  "buildingName": "string",
  "fax": "string",
  "numberRangeIdentifierType": {
    "name": "string"
  },
  "numberRangeIdentifierValue": "string",
  "allowsSystemGenerateNewId": true,
  "numberRangeType": {
    "name": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact - Update Contact

HTTP Request

PUT /api/contacts/{id}

Interactive Demo

📋 Description: Updates the contact information for a specified individual within the Nakisa Portfolio Management Suite, ensuring accurate and up-to-date records for portfolio, asset, and real estate property analytics.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ContactDto	true	Request body containing the updated contact information, including portfolio associations and analytics data relevant to real estate properties.

Body Parameters

{
  "id": 0,
  "displayId": "string",
  "name": "string",
  "position": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "description": "string",
  "group": "string",
  "buildingName": "string",
  "fax": "string",
  "numberRangeIdentifierType": {
    "name": "string"
  },
  "numberRangeIdentifierValue": "string",
  "allowsSystemGenerateNewId": true,
  "numberRangeType": {
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ContactDto

Example Responses

{
  "id": 0,
  "displayId": "string",
  "name": "string",
  "position": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "description": "string",
  "group": "string",
  "buildingName": "string",
  "fax": "string",
  "numberRangeIdentifierType": {
    "name": "string"
  },
  "numberRangeIdentifierValue": "string",
  "allowsSystemGenerateNewId": true,
  "numberRangeType": {
    "name": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact - Delete Contact

HTTP Request

DELETE /api/contacts/{id}

Interactive Demo

📋 Description: Deletes a specified contact from the Nakisa Portfolio Management Suite, ensuring the integrity of portfolio and asset data within the real estate property analytics framework.

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

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact - Get Contact Types

HTTP Request

GET /api/contacts/{id}/contact-types

Interactive Demo

📋 Description: Retrieves the contact types associated with a specific contact identified by the provided ID, 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

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[PickListOptionDto]	false	none	[Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.]
» 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
» priority	integer(int64)	false	none	Priority of the resource
» internalId	integer(int64)	false	none	Unique identifier for the internal
» pickListCode	string	false	none	Code for the pick list
» pickListLabel	string	false	none	Label for the pick list
» label	string	false	none	Label for the resource
» cultureId	integer(int64)	false	none	Unique identifier for the culture
» labelDtos	[LabelDto]	false	none	List of labelDtos items
»» 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
»» cultureId	integer(int64)	false	none	Unique identifier for the culture
»» value	string	true	none	Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact - Create Or Update Contact Types

HTTP Request

PUT /api/contacts/{id}/contact-types

Interactive Demo

📋 Description: Updates the contact types associated with a specific contact in the Nakisa Portfolio Management Suite, enabling enhanced categorization and analytics for portfolio and asset management within real estate properties.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	array[integer]	true	Request body containing the updated contact type information for the specified contact ID, including relevant attributes for portfolio and asset management within the Nakisa Portfolio Management Suite.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

[
  {
    "createdBy": "string",
    "lastModifiedBy": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "lastModifiedDate": "2019-08-24T14:15:22Z",
    "archived": true,
    "externalId": "string",
    "id": 0,
    "priority": 0,
    "internalId": 0,
    "pickListCode": "string",
    "pickListLabel": "string",
    "label": "string",
    "cultureId": 0,
    "labelDtos": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "cultureId": 0,
        "value": "string"
      }
    ]
  }
]

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[PickListOptionDto]	false	none	[Data transfer object representing an option within a pick list, utilized for categorizing and managing portfolio assets and analytics in the Nakisa Portfolio Management Suite, particularly in the context of real estate property management.]
» 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
» priority	integer(int64)	false	none	Priority of the resource
» internalId	integer(int64)	false	none	Unique identifier for the internal
» pickListCode	string	false	none	Code for the pick list
» pickListLabel	string	false	none	Label for the pick list
» label	string	false	none	Label for the resource
» cultureId	integer(int64)	false	none	Unique identifier for the culture
» labelDtos	[LabelDto]	false	none	List of labelDtos items
»» 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
»» cultureId	integer(int64)	false	none	Unique identifier for the culture
»» value	string	true	none	Represents the descriptive value associated with a portfolio asset, facilitating analytics and insights within the Nakisa Portfolio Management Suite.

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact - Get Contacts

HTTP Request

GET /api/contacts

Interactive Demo

📋 Description: Retrieves a list of contacts associated with real estate properties within the Nakisa Portfolio Management Suite, enabling users to access key portfolio and asset information for enhanced analytics.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing users to efficiently retrieve and manage large sets of contact data within the Nakisa Portfolio Management Suite.
address	query	string	false	Specifies the address of the real estate property to retrieve associated portfolio and asset analytics within the Nakisa Portfolio Management Suite.
description	query	string	false	Description of the resource
email	query	string	false	Email address of the contact, used to retrieve associated portfolio, asset, and analytics information within the Nakisa Portfolio Management Suite.
name	query	string	false	Name of the resource
name-like	query	string	false	Filters the list of contacts based on a partial match of the name, facilitating efficient search and retrieval within the Nakisa Portfolio Management Suite’s portfolio and asset management functionalities.
phone	query	string	false	Contact phone number associated with the real estate property, used for portfolio and asset management within the Nakisa Portfolio Management Suite.
position	query	string	false	Specifies the position within the portfolio hierarchy to filter contacts related to assets and real estate properties in the Nakisa Portfolio Management Suite.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagedModelEntityModelContactDto

Example Responses

{
  "_embedded": {
    "contacts": [
      {
        "createdBy": "string",
        "lastModifiedBy": "string",
        "createdDate": "2019-08-24T14:15:22Z",
        "lastModifiedDate": "2019-08-24T14:15:22Z",
        "archived": true,
        "externalId": "string",
        "id": 0,
        "address": "string",
        "description": "string",
        "email": "string",
        "name": "string",
        "phone": "string",
        "position": "string",
        "fax": "string",
        "contactTypes": [
          {
            "createdBy": "string",
            "lastModifiedBy": "string",
            "createdDate": "2019-08-24T14:15:22Z",
            "lastModifiedDate": "2019-08-24T14:15:22Z",
            "archived": true,
            "externalId": "string",
            "id": 0,
            "priority": 0,
            "internalId": 0,
            "pickListCode": "string",
            "pickListLabel": "string",
            "label": "string",
            "cultureId": 0,
            "labelDtos": [
              {
                "createdBy": "string",
                "lastModifiedBy": "string",
                "createdDate": "2019-08-24T14:15:22Z",
                "lastModifiedDate": "2019-08-24T14:15:22Z",
                "archived": true,
                "externalId": "string",
                "id": 0,
                "cultureId": 0,
                "value": "string"
              }
            ]
          }
        ]
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact - Create Contacts

HTTP Request

POST /api/contacts

Interactive Demo

📋 Description: Creates a new contact within the Nakisa Portfolio Management Suite, enabling users to effectively manage relationships related to portfolios, assets, and real estate properties.

Parameters

Name	In	Type	Required	Description
body	body	ContactDto	true	Request body containing the contact information and associated metadata for real estate properties within the Nakisa Portfolio Management Suite.

Body Parameters

[
  {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "position": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "description": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeIdentifierValue": "string",
    "allowsSystemGenerateNewId": true,
    "numberRangeType": {
      "name": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

[
  {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "position": "string",
    "email": "string",
    "phone": "string",
    "address": "string",
    "description": "string",
    "group": "string",
    "buildingName": "string",
    "fax": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeIdentifierValue": "string",
    "allowsSystemGenerateNewId": true,
    "numberRangeType": {
      "name": "string"
    }
  }
]

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

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Contact - Archive Contact

HTTP Request

POST /api/contacts/{id}/archive

Interactive Demo

📋 Description: Archives a specified contact within the Nakisa Portfolio Management Suite, facilitating streamlined asset management and enhancing portfolio 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	ContactDto

Example Responses

{
  "id": 0,
  "displayId": "string",
  "name": "string",
  "position": "string",
  "email": "string",
  "phone": "string",
  "address": "string",
  "description": "string",
  "group": "string",
  "buildingName": "string",
  "fax": "string",
  "numberRangeIdentifierType": {
    "name": "string"
  },
  "numberRangeIdentifierValue": "string",
  "allowsSystemGenerateNewId": true,
  "numberRangeType": {
    "name": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---