Site Location View

Site Location View - Get Sites

HTTP Request

GET /api/site-locations

📋 Description: Retrieves a list of site locations within the Nakisa Portfolio Management Suite, enabling users to analyze and manage real estate properties and their associated assets effectively.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

true

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

listing

query

boolean

false

Indicates whether to include detailed listing information for each site location in the portfolio analytics response.

search

query

string

false

Search term used to filter site locations within the Nakisa Portfolio Management Suite, enhancing portfolio and asset analytics for real estate properties.

id-in

query

string

false

Unique identifier for the site location within the Nakisa Portfolio Management Suite, facilitating precise retrieval of portfolio and asset analytics related to real estate properties.

external-id

query

string

false

Unique identifier for the external asset associated with site locations, facilitating streamlined portfolio and real estate property analytics.

external-id-like

query

string

false

Filters the site locations based on a specified external identifier, facilitating asset management and analytics within the Nakisa Portfolio Management Suite.

city-id

query

string

false

Unique identifier for the city within the Nakisa Portfolio Management Suite, used to retrieve specific site location data related to portfolio, asset, and real estate property analytics.

city-name-like

query

string

false

Specifies a partial or full name of a city to filter site locations relevant to portfolio and asset analytics within the Nakisa Portfolio Management Suite.

file-number

query

string

false

Unique identifier for the specific asset file within the Nakisa Portfolio Management Suite, facilitating precise retrieval of site location data related to portfolio and real estate property analytics.

file-number-like

query

string

false

Specifies a string pattern to filter site locations based on their associated file numbers, facilitating targeted asset and portfolio analytics within the Nakisa Portfolio Management Suite.

name

query

string

false

Name of the resource

name-like

query

string

false

Filters site locations based on a specified name or partial name, enhancing the search capabilities within the Nakisa Portfolio Management Suite for portfolio and asset management.

archived

query

string

false

Indicates whether the site location is archived, allowing users to filter results based on active or inactive real estate properties within the Nakisa Portfolio Management Suite.

store-number

query

string

false

Unique identifier for the specific store within the Nakisa Portfolio Management Suite, used to retrieve relevant site location data for portfolio and asset analytics in real estate property management.

store-number-like

query

string

false

Filters the site locations based on a specified store number pattern, enabling targeted analytics for portfolio and asset management within the Nakisa Portfolio Management Suite.

property-type-id

query

string

false

Unique identifier for the type of property within the Nakisa Portfolio Management Suite, used to filter site locations in portfolio and asset analytics.

status-id

query

string

false

Unique identifier for the status of site locations within the Nakisa Portfolio Management Suite, facilitating effective portfolio and asset analytics in real estate property management.

status-id-in

query

string

false

Specifies the unique identifier for the status of site locations within the Nakisa Portfolio Management Suite, facilitating targeted retrieval of portfolio, asset, and real estate property analytics.

Responses

Status

Meaning

Description

Schema

200

OK

OK

PagedModelEntityModelSiteLocationViewDto

Example Responses

  1{
  2  "_embedded": {
  3    "siteLocationViewDtoList": [
  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        "storeNumber": "string",
 14        "fileNumber": "string",
 15        "siteStatusId": 0,
 16        "propertyTypeId": 0,
 17        "addressId": 0,
 18        "referenceLocationId": 0,
 19        "addressDto": {
 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          "street": "string",
 28          "civicNumber": "string",
 29          "suite": "string",
 30          "postalCode": "string",
 31          "lon": 0.1,
 32          "lat": 0.1,
 33          "city": {
 34            "createdBy": "string",
 35            "lastModifiedBy": "string",
 36            "createdDate": "2019-08-24T14:15:22Z",
 37            "lastModifiedDate": "2019-08-24T14:15:22Z",
 38            "archived": true,
 39            "externalId": "string",
 40            "id": 0,
 41            "name": "string",
 42            "province": {
 43              "createdBy": "string",
 44              "lastModifiedBy": "string",
 45              "createdDate": "2019-08-24T14:15:22Z",
 46              "lastModifiedDate": "2019-08-24T14:15:22Z",
 47              "archived": true,
 48              "externalId": "string",
 49              "id": 0,
 50              "name": "string",
 51              "code": "string",
 52              "country": {
 53                "createdBy": "string",
 54                "lastModifiedBy": "string",
 55                "createdDate": "2019-08-24T14:15:22Z",
 56                "lastModifiedDate": "2019-08-24T14:15:22Z",
 57                "archived": true,
 58                "externalId": "string",
 59                "id": 0,
 60                "name": "string",
 61                "code": "string"
 62              },
 63              "provinceCountryKey": "string"
 64            },
 65            "cityProvinceCountryKey": "string"
 66          },
 67          "district": {
 68            "createdBy": "string",
 69            "lastModifiedBy": "string",
 70            "createdDate": "2019-08-24T14:15:22Z",
 71            "lastModifiedDate": "2019-08-24T14:15:22Z",
 72            "archived": true,
 73            "externalId": "string",
 74            "id": 0,
 75            "name": "string",
 76            "city": {
 77              "createdBy": "string",
 78              "lastModifiedBy": "string",
 79              "createdDate": "2019-08-24T14:15:22Z",
 80              "lastModifiedDate": "2019-08-24T14:15:22Z",
 81              "archived": true,
 82              "externalId": "string",
 83              "id": 0,
 84              "name": "string",
 85              "province": {
 86                "createdBy": "string",
 87                "lastModifiedBy": "string",
 88                "createdDate": "2019-08-24T14:15:22Z",
 89                "lastModifiedDate": "2019-08-24T14:15:22Z",
 90                "archived": true,
 91                "externalId": "string",
 92                "id": 0,
 93                "name": "string",
 94                "code": "string",
 95                "country": {
 96                  "createdBy": "string",
 97                  "lastModifiedBy": "string",
 98                  "createdDate": "2019-08-24T14:15:22Z",
 99                  "lastModifiedDate": "2019-08-24T14:15:22Z",
100                  "archived": true,
101                  "externalId": "string",
102                  "id": 0,
103                  "name": "string",
104                  "code": "string"
105                },
106                "provinceCountryKey": "string"
107              },
108              "cityProvinceCountryKey": "string"
109            }
110          },
111          "cityId": 0,
112          "districtId": 0
113        },
114        "siteStatus": {
115          "createdBy": "string",
116          "lastModifiedBy": "string",
117          "createdDate": "2019-08-24T14:15:22Z",
118          "lastModifiedDate": "2019-08-24T14:15:22Z",
119          "archived": true,
120          "externalId": "string",
121          "id": 0,
122          "priority": 0,
123          "internalId": 0,
124          "pickListCode": "string",
125          "pickListLabel": "string",
126          "label": "string",
127          "cultureId": 0,
128          "labelDtos": [
129            {
130              "createdBy": "string",
131              "lastModifiedBy": "string",
132              "createdDate": "2019-08-24T14:15:22Z",
133              "lastModifiedDate": "2019-08-24T14:15:22Z",
134              "archived": true,
135              "externalId": "string",
136              "id": 0,
137              "cultureId": 0,
138              "value": "string"
139            }
140          ]
141        },
142        "propertyType": {
143          "createdBy": "string",
144          "lastModifiedBy": "string",
145          "createdDate": "2019-08-24T14:15:22Z",
146          "lastModifiedDate": "2019-08-24T14:15:22Z",
147          "archived": true,
148          "externalId": "string",
149          "id": 0,
150          "priority": 0,
151          "internalId": 0,
152          "pickListCode": "string",
153          "pickListLabel": "string",
154          "label": "string",
155          "cultureId": 0,
156          "labelDtos": [
157            {
158              "createdBy": "string",
159              "lastModifiedBy": "string",
160              "createdDate": "2019-08-24T14:15:22Z",
161              "lastModifiedDate": "2019-08-24T14:15:22Z",
162              "archived": true,
163              "externalId": "string",
164              "id": 0,
165              "cultureId": 0,
166              "value": "string"
167            }
168          ]
169        }
170      }
171    ]
172  },
173  "page": {
174    "size": 0,
175    "totalElements": 0,
176    "totalPages": 0,
177    "number": 0
178  }
179}