Geographic Definition Resource¶
Get¶
HTTP Request
GET /api/geographic
📋 Description: Fetches geographic data relevant to business operations, enabling users to access location-based insights for informed decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entityId |
query |
integer(int64) |
true |
Unique identifier for the entity |
entityType |
query |
string |
true |
Type of the entity |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
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}
Upsert¶
HTTP Request
POST /api/geographic
📋 Description: Submits geographic data for processing and integration into the system, enabling enhanced location-based analytics and decision-making.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing geographic data parameters, including location identifiers and associated attributes for analysis and reporting. |
Body Parameters
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}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
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}
Update Physical Location¶
HTTP Request
POST /api/geographic/updatePhysicalLocation
📋 Description: Updates the physical location of a specified entity within the system, ensuring accurate geographic data for operational efficiency and resource allocation.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the updated physical location details, including address, coordinates, and associated metadata for accurate geographic representation. |
Body Parameters
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}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Disable Custom Address¶
HTTP Request
POST /api/geographic/disableCustomAddress
📋 Description: Disables a custom address within the geographic settings, ensuring that the specified address is no longer available for use in the system. This operation is essential for maintaining accurate and relevant address data in business operations.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the details of the custom address to be disabled, including its unique identifier and relevant metadata. |
Body Parameters
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}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Search Coordinates¶
HTTP Request
GET /api/geographic/searchCoordinates
📋 Description: Retrieves geographic coordinates based on specified search criteria, enabling businesses to effectively locate and analyze spatial data for decision-making purposes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
query |
query |
string |
true |
Search term used to specify the geographic location for which coordinates are being requested. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Example Responses
1"string"