AddressDto

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  "street": "string",
10  "civicNumber": "string",
11  "suite": "string",
12  "postalCode": "string",
13  "lon": 0.1,
14  "lat": 0.1,
15  "city": {
16    "createdBy": "string",
17    "lastModifiedBy": "string",
18    "createdDate": "2019-08-24T14:15:22Z",
19    "lastModifiedDate": "2019-08-24T14:15:22Z",
20    "archived": true,
21    "externalId": "string",
22    "id": 0,
23    "name": "string",
24    "province": {
25      "createdBy": "string",
26      "lastModifiedBy": "string",
27      "createdDate": "2019-08-24T14:15:22Z",
28      "lastModifiedDate": "2019-08-24T14:15:22Z",
29      "archived": true,
30      "externalId": "string",
31      "id": 0,
32      "name": "string",
33      "code": "string",
34      "country": {
35        "createdBy": "string",
36        "lastModifiedBy": "string",
37        "createdDate": "2019-08-24T14:15:22Z",
38        "lastModifiedDate": "2019-08-24T14:15:22Z",
39        "archived": true,
40        "externalId": "string",
41        "id": 0,
42        "name": "string",
43        "code": "string"
44      },
45      "provinceCountryKey": "string"
46    },
47    "cityProvinceCountryKey": "string"
48  },
49  "district": {
50    "createdBy": "string",
51    "lastModifiedBy": "string",
52    "createdDate": "2019-08-24T14:15:22Z",
53    "lastModifiedDate": "2019-08-24T14:15:22Z",
54    "archived": true,
55    "externalId": "string",
56    "id": 0,
57    "name": "string",
58    "city": {
59      "createdBy": "string",
60      "lastModifiedBy": "string",
61      "createdDate": "2019-08-24T14:15:22Z",
62      "lastModifiedDate": "2019-08-24T14:15:22Z",
63      "archived": true,
64      "externalId": "string",
65      "id": 0,
66      "name": "string",
67      "province": {
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        "code": "string",
77        "country": {
78          "createdBy": "string",
79          "lastModifiedBy": "string",
80          "createdDate": "2019-08-24T14:15:22Z",
81          "lastModifiedDate": "2019-08-24T14:15:22Z",
82          "archived": true,
83          "externalId": "string",
84          "id": 0,
85          "name": "string",
86          "code": "string"
87        },
88        "provinceCountryKey": "string"
89      },
90      "cityProvinceCountryKey": "string"
91    }
92  },
93  "cityId": 0,
94  "districtId": 0
95}

📄 Description: Data transfer object representing a physical address, including essential components such as street, city, state, and postal code, to facilitate accurate location identification in business transactions.

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 address 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

street

string

false

none

Represents the street address component of the location, essential for accurate delivery and service routing.

civicNumber

string

false

none

Represents the civic number associated with the address, serving as a key element for accurate location identification in business transactions.

suite

string

false

none

Represents the suite number within an address, providing essential detail for accurate location identification.

postalCode

string

false

none

Code for the postal

lon

number(double)

false

none

Represents the longitude coordinate of the address, essential for precise geolocation and mapping functionalities.

lat

number(double)

false

none

Represents the latitude coordinate of the address, essential for precise geolocation and mapping functionalities.

city

City

false

none

Represents the city component of an address, facilitating accurate location identification for service delivery and communication.

district

District

false

none

Represents the district associated with the address, providing essential geographical context for location-based services.

cityId

integer(int64)

false

none

Unique identifier for the city

districtId

integer(int64)

false

none

Unique identifier for the district