GeographicDefinitionDTO

Example Json Object

 1{
 2  "id": 0,
 3  "createdBy": "string",
 4  "createdAt": "2019-08-24T14:15:22Z",
 5  "entityId": 0,
 6  "entityType": "string",
 7  "shapeCoordinates": "string",
 8  "fullAddress": "string",
 9  "physicalLocation": "string",
10  "addressOverride": true,
11  "addressEditable": true,
12  "premiseDisplayId": "string"
13}

📄 Description: Data transfer object representing the geographic definitions used for regional analysis and reporting, facilitating informed decision-making in business strategy and operations.

Properties

Name

Type

Required

Restrictions

Description

id

integer(int64)

false

none

Unique identifier for the resource

createdBy

string

false

none

Username of who created this resource

createdAt

string(date-time)

false

none

Timestamp when this resource was created

entityId

integer(int64)

false

none

Unique identifier for the entity

entityType

string

false

none

Type of the entity

shapeCoordinates

string

false

none

String representation of geographic coordinates defining the shape of a specific area for mapping and spatial analysis purposes.

fullAddress

string

false

none

Complete representation of a location, combining street address, city, state, and postal code, essential for accurate geographic identification and service delivery.

physicalLocation

string

false

none

Represents the physical location associated with the geographic definition, providing essential context for location-based business operations.

addressOverride

boolean

false

none

Indicates whether the address provided should override the default address settings for the geographic definition.

addressEditable

boolean

false

none

Indicates whether the geographic address associated with the entity can be modified by the user.

premiseDisplayId

string

false

none

Unique identifier for the premise display