City

Example Json Object

 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  "province": {
11    "createdBy": "string",
12    "lastModifiedBy": "string",
13    "createdDate": "2019-08-24T14:15:22Z",
14    "lastModifiedDate": "2019-08-24T14:15:22Z",
15    "archived": true,
16    "externalId": "string",
17    "id": 0,
18    "name": "string",
19    "code": "string",
20    "country": {
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      "name": "string",
29      "code": "string"
30    },
31    "provinceCountryKey": "string"
32  },
33  "cityProvinceCountryKey": "string"
34}

📄 Description: Data transfer object representing a city, encapsulating essential attributes such as name, population, and geographical coordinates, to facilitate location-based services and urban planning initiatives.

Properties

Name

Type

Required

Restrictions

Description

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

Indicates whether the city record has been archived, reflecting its current status within the system.

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

province

Province

false

none

Represents the province associated with the city, providing essential geographic context for location-based services and analysis.

cityProvinceCountryKey

string

false

none

Unique identifier representing the combination of city, province, and country for accurate geographic categorization within the system.