External Sale Category¶
Get External Sale Category¶
HTTP Request
GET /api/external-sale-categories/{id}
📋 Description: Retrieves detailed information about a specific external sale category identified by the provided ID, 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 |
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 "name": "string"
10}
Update External Sale Category¶
HTTP Request
PUT /api/external-sale-categories/{id}
📋 Description: Updates the details of an external sale category identified by the specified ID, enabling accurate asset classification and enhanced 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 |
true |
Request body containing the updated external sale category details, including attributes relevant to portfolio management and asset analytics for real estate properties. |
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 "name": "string"
10}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
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 "name": "string"
10}
Delete External Sale Category¶
HTTP Request
DELETE /api/external-sale-categories/{id}
📋 Description: Deletes a specified external sale category from the Nakisa Portfolio Management Suite, streamlining portfolio management and asset analytics within real estate property operations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get External Sale Categories¶
HTTP Request
GET /api/external-sale-categories
📋 Description: Retrieves a list of external sale categories relevant to portfolio management, asset analytics, and real estate properties, enabling users to effectively categorize and analyze sales data.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results of the external sale categories query should be returned in a paginated format, facilitating efficient data retrieval for portfolio and asset management analytics. |
|
search |
query |
string |
false |
Search term used to filter and retrieve specific external sale categories related to portfolio, asset, analytics, and real estate property within the Nakisa Portfolio Management Suite. |
name |
query |
string |
false |
Name of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "_embedded": {
3 "externalSaleCategories": [
4 {
5 "createdBy": "string",
6 "lastModifiedBy": "string",
7 "createdDate": "2019-08-24T14:15:22Z",
8 "lastModifiedDate": "2019-08-24T14:15:22Z",
9 "archived": true,
10 "externalId": "string",
11 "id": 0,
12 "name": "string"
13 }
14 ]
15 },
16 "page": {
17 "size": 0,
18 "totalElements": 0,
19 "totalPages": 0,
20 "number": 0
21 }
22}
Add External Sale Categories¶
HTTP Request
POST /api/external-sale-categories
📋 Description: Creates new external sale categories within the Nakisa Portfolio Management Suite, enabling enhanced organization and analytics of portfolio assets related to real estate properties.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the external sale category details, including attributes relevant to portfolio management and real estate analytics. |
Body Parameters
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 "name": "string"
11 }
12]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
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 "name": "string"
11 }
12]
Response Schema
Status Code 201
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an external sale category within the Nakisa Portfolio Management Suite, facilitating the classification and analysis of real estate property transactions in the context of portfolio and asset 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 |
» name |
string |
true |
none |
Name of the resource |
Archive External Sale Category¶
HTTP Request
POST /api/external-sale-categories/{id}/archive
📋 Description: Archives a specified external sale category within the Nakisa Portfolio Management Suite, facilitating streamlined asset management and 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 |
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 "name": "string"
10}