Province¶
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 "code": "string",
11 "country": {
12 "createdBy": "string",
13 "lastModifiedBy": "string",
14 "createdDate": "2019-08-24T14:15:22Z",
15 "lastModifiedDate": "2019-08-24T14:15:22Z",
16 "archived": true,
17 "externalId": "string",
18 "id": 0,
19 "name": "string",
20 "code": "string"
21 },
22 "provinceCountryKey": "string"
23}
📄 Description: Data transfer object representing a geographical province, encapsulating essential attributes such as name, code, and associated demographics, to facilitate regional analysis and decision-making in business operations.
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 province record has been archived, reflecting its current status in 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 |
code |
string |
false |
none |
Code identifier for the resource |
country |
false |
none |
Represents the country associated with the province, providing essential geographical context for regional data analysis and reporting. |
|
provinceCountryKey |
string |
false |
none |
Unique identifier for the province associated with a specific country, facilitating accurate geographical categorization within the system. |