Sdk Configurations
Get Default Configurations
Endpoint:
GET api/v9/content/draft/clients/{clientIdentifier}/sdk-configurations/default-keys
Description:
Returns default configurations values
Success Response:
[
{
"key": "sdk_styleJsonUrl",
"defaultValue": "",
"type": "String",
"readableKey": "Style JSON URL",
"description": "style.json file used for map widget",
"maxValue": null,
"minValue": null,
"level": "advanced",
"scope": "client",
"category": "SDK",
"categoryDescription": "Parameters for general SDK operations."
},
{
"key": "userInterface_maximumZoomLevel",
"defaultValue": "18.5",
"type": "Float",
"readableKey": "Max Zoom Scale",
"description": "Maximum zoom level allowed for the map",
"maxValue": "24.0",
"minValue": "0.0",
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_minimumZoomLevel",
"defaultValue": "16",
"type": "Float",
"readableKey": "Min Zoom Scale",
"description": "Minimum zoom level allowed for the map",
"maxValue": "24.0",
"minValue": "0.0",
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_poiCategories",
"defaultValue": "",
"type": "String",
"readableKey": "POI Categories",
"description": "Used to populate the quick access categories",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_privacyPolicyUrl",
"defaultValue": "https://www.pointr.tech/technology/privacy-and-security",
"type": "String",
"readableKey": "Privacy Policy URL",
"description": "Privacy Policy URL",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_supportEmail",
"defaultValue": "support@pointr.tech",
"type": "String",
"readableKey": "Support Email",
"description": "Support Email",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_appLogoUrl",
"defaultValue": "",
"type": "String",
"readableKey": "App Logo URL",
"description": "App logo URL that points to an image. PNG and JPEG images are supported. The image should be square with width/height no larger than 700px.",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_infoPageUrl",
"defaultValue": "https://pointr-websdk.azureedge.net/ui-configuration/web-sdk-v8/info-page/info-page.html",
"type": "String",
"readableKey": "Info Page URL",
"description": "Info Page URL",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_termsAndConditionsUrl",
"defaultValue": "https://www.pointr.tech/end-user-agreement",
"type": "String",
"readableKey": "Terms and Conditions URL",
"description": "Terms and Conditions URL",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_isRatingPopupEnabled",
"defaultValue": "True",
"type": "Boolean",
"readableKey": "Rating Popup Enabled",
"description": "Whether the rate experience pop-up is enabled. Analytics also need to be enabled.",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_isSearchCategoriesEnabled",
"defaultValue": "True",
"type": "Boolean",
"readableKey": "Enable Search Categories",
"description": "Whether the categories search UI is enabled",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_isInfoButtonEnabled",
"defaultValue": "True",
"type": "Boolean",
"readableKey": "Info Button Enabled",
"description": "Whether to enable the info button",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_isOnboardingEnabledForSdk",
"defaultValue": "True",
"type": "Boolean",
"readableKey": "Enable Onboarding for SDK",
"description": "Whether to enable onboarding screens. Only applies to SDK as onboarding is mandatory for Pointr Express.",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_isSplashScreenEnabledForSdk",
"defaultValue": "False",
"type": "Boolean",
"readableKey": "Enable Splash Screen for SDK",
"description": "Whether to display the splash screen. Only applies to SDK as splash screen is mandatory for Pointr Express.",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_isMarkMyCarEnabled",
"defaultValue": "True",
"type": "Boolean",
"readableKey": "Mark my car Enabled",
"description": "Whether mark my car feature is enabled.",
"maxValue": null,
"minValue": null,
"level": "basic",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_categorySymbolFrame",
"defaultValue": "2",
"type": "Integer",
"readableKey": "Category Symbol Frame Type",
"description": "What frame to use behind category symbols none (0), circle (1), rounded (2), square (3)",
"maxValue": "3",
"minValue": "0",
"level": "advanced",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_distanceUnit",
"defaultValue": "0",
"type": "Integer",
"readableKey": "Distance Unit",
"description": "What type of units should be used for distance in the UI",
"maxValue": null,
"minValue": "0",
"level": "advanced",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_defaultOutdoorLocationZoomLevel",
"defaultValue": "18",
"type": "Float",
"readableKey": "Default Outdoor Location Zoom Level",
"description": "The default zoom level for outdoors",
"maxValue": "24.0",
"minValue": "0.0",
"level": "advanced",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
},
{
"key": "userInterface_quickAccessTiltAngle",
"defaultValue": "45",
"type": "Float",
"readableKey": "Quick Access Tilt Angle (deg)",
"description": "Map tilt angle applied while on quick access mode",
"maxValue": "360.0",
"minValue": "0.0",
"level": "advanced",
"scope": "client",
"category": "User Interface",
"categoryDescription": "Parameters for user interface"
}
]
* You can access the possible response codes you may encounter here.
Get UUID
Endpoint:
GET api/v9/content/draft/clients/{clientIdentifier}/sdk-configurations/uuids
GET api/v9/content/published/clients/{clientIdentifier}/sdk-configurations/uuids
Description:
UUID should be served with seperated endpoints. Because of it's related with content. We should add this to configurations response
The static assets will be served via CDN for faster content delivery.(Published)
Success Response:
Response Example:
{
"1": "63055871-0b25-4498-a635-e9d18e78bd10",
"2": "10354330-05d1-42b0-80c1-a71abf9f49a6",
"3": "34073439-c86a-4e28-a25a-c0131d6b883d",
"4": "ca8f1901-4676-4d33-a385-f0a1ca08b446",
"5": "746b38cc-2dc0-487b-883b-a788f253666b",
"6": "10354330-05d1-42b0-80c1-a71abf9f49a3",
"7": "87e7bf73-ebe1-41d4-b4ae-da5322f6c751"
}
* You can access the possible response codes you may encounter here.
Get SDK Configuration For Client (Draft)
Endpoint:
GET api/v9/content/draft/clients/{clientIdentifier}/sdk-configurations
Description:
Returns draft SDK configuration of select""ed client including nested site and building
Success Response:
{
"client": [
{
"key": "poiManagerConfiguration_categories",
"value": "Value",
"valueType": "String"
},
{
"key": "sdkConfiguration_styleJsonUrl",
"value": "https://pointrmapstorage.blob.core.windows.net/style/8.6.0/aviation.json",
"valueType": "String"
}
],
"sites": [
{
"siteIdentifier": "e450f654-702c-4318-878e-a3f1dc82ca4a",
"configurations": [
{
"key": "poiManagerConfiguration_categories",
"value": "Value",
"ValueType": "String"
}
],
"buildings": [
{
"buildingIdentifier": "5e25ec07-17ad-406d-aa32-974ce9b4760b",
"configurations": [
{
"key": "poiManagerConfiguration_categories",
"value": "Value",
"ValueType": "String"
}
]
}
]
}
]
}
* You can access the possible response codes you may encounter here.
Get SDK Configuration For Site (Draft)
Endpoint:
GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/sdk-configurations
Description:
Returns draft SDK configuration of selected site including nested building
Success Response:
{
"sites": [
{
"siteIdentifier": "4e4f3b17-ae2e-467f-9abd-097d9d530aac",
"configurations": [
{
"key": "poiManagerConfiguration_categories",
"value": "True",
"ValueType": "Boolean"
}
],
"buildings": [
{
"buildingIdentifier": "47304104-7085-421c-bb16-2d0c5ce0bfae",
"configurations": [
{
"key": "poiManagerConfiguration_categories",
"value": "Value",
"ValueType": "String"
}
]
}
]
}
]
}
* You can access the possible response codes you may encounter here.
Get SDK Configuration For Building (Draft)
Endpoint:
GET api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/sdk-configurations
Description:
Returns draft SDK configuration of selected building
Success Response:
{
"buildings": [
{
"buildingIdentifier": "4d96ede2-66b1-463f-8644-997498628e9a",
"configurations": [
{
"key": "poiManagerConfiguration_categories",
"value": "Value",
"ValueType": "String"
}
]
}
]
}
* You can access the possible response codes you may encounter here.
Get SDK Configuration For Client (Published)
Endpoint:
GET api/v9/content/published/clients/{clientIdentifier}/sdk-configurations
Description:
Returns published SDK configuration of selected client including nested site and building
The static assets will be served via CDN for faster content delivery.
Success Response:
{
"client": [
{
"key": "poiManagerConfiguration_categories",
"value": "Value",
"ValueType": "String"
},
{
"key": "sdkConfiguration_styleJsonUrl",
"value": "https://pointrmapstorage.blob.core.windows.net/style/8.6.0/aviation.json",
"ValueType": "String"
}
],
"sites": [
{
"siteIdentifier": "477c75d0-74f8-4a83-849e-53128b92b947",
"configurations": [
{
"key": "poiManagerConfiguration_categories",
"value": "Value",
"ValueType": "String"
}
],
"buildings": [
{
"buildingIdentifier": "f561d689-e24f-4c0b-b6a4-5acbf21eb050",
"configurations": [
{
"key": "poiManagerConfiguration_categories",
"value": "Value",
"ValueType": "String"
}
]
}
]
}
]
}
* You can access the possible response codes you may encounter here.
Update Sdk Configuration For Client
Endpoint:
PUT api/v9/content/draft/clients/{clientIdentifier}/sdk-configurations
Description:
This endpoint is used to update SDK configurations for a specific client. It Add or Update SDK configuration records associated with the given clientIdentifier.
Validations
- ConfigurationKey is required.
- ConfigurationValue is required and length can not exceed 5000 characters.
- ConfigurationValueType is required.
- ConfigurationValueType must be one of
"Float","Double","Integer","Boolean","String".
Request:
[
{
"configurationKey": "poiManagerConfiguration_categories",
"configurationValue": "Value",
"configurationValueType": "String"
},
{
"configurationKey": "sdkConfiguration_styleJsonUrl",
"configurationValue": "https://pointrmapstorage.blob.core.windows.net/style/8.6.0/aviation.json",
"configurationValueType": "String"
}
]
Success Response:
{
"message": "Sdk configurations updated successfully."
}
* You can access the possible response codes you may encounter here.
Update Sdk Configuration For Site
Endpoint:
PUT api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/sdk-configurations
Description:
This endpoint is used to update SDK configurations for a specific site. It Add or Update SDK configuration records associated with the given clientIdentifier and siteIdentifier.
Validations
- ConfigurationKey is required.
- ConfigurationValue is required and length can not exceed 5000 characters.
- ConfigurationValueType is required.
- ConfigurationValueType must be one of
"Float","Double","Integer","Boolean","String".
Request:
[
{
"configurationKey": "poiManagerConfiguration_categories",
"configurationValue": "Value",
"configurationValueType": "String"
},
{
"configurationKey": "sdkConfiguration_styleJsonUrl",
"configurationValue": "https://pointrmapstorage.blob.core.windows.net/style/8.6.0/aviation.json",
"configurationValueType": "String"
}
]
Success Response:
{
"message": "Sdk configurations updated successfully."
}
* You can access the possible response codes you may encounter here.
Update Sdk Configuration For Building
Endpoint:
PUT api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/sdk-configurations
Description:
This endpoint is used to update SDK configurations for a specific building. It Add or Update SDK configuration records associated with the given clientIdentifier, siteIdentifier and buildingIdentifier.
Validations
- ConfigurationKey is required.
- ConfigurationValue is required and length can not exceed 5000 characters.
- ConfigurationValueType is required.
- ConfigurationValueType must be one of
"Float","Double","Integer","Boolean","String".
Request:
[
{
"configurationKey": "poiManagerConfiguration_categories",
"configurationValue": "Value",
"configurationValueType": "String"
},
{
"configurationKey": "sdkConfiguration_styleJsonUrl",
"configurationValue": "https://pointrmapstorage.blob.core.windows.net/style/8.6.0/aviation.json",
"configurationValueType": "String"
}
]
Success Response:
{
"message": "Sdk configurations updated successfully."
}
* You can access the possible response codes you may encounter here.
Delete Sdk Configurations For Client
Endpoint:
DELETE api/v9/content/draft/clients/{clientIdentifier}/sdk-configurations
Description:
This endpoint is used to delete SDK configurations for a specific client.
Success Response:
{
"message": "Sdk configurations deleted successfully."
}
* You can access the possible response codes you may encounter here.
Delete Sdk Configuration For Client
Endpoint:
DELETE api/v9/content/draft/clients/{clientIdentifier}/sdk-configurations/{key}
Description:
This endpoint is used to delete SDK configuration for a specific key with given clientIdentifier.
Success Response:
{
"message": "Sdk configurations deleted successfully."
}
* You can access the possible response codes you may encounter here.
Delete Sdk Configurations For Site
Endpoint:
DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/sdk-configurations
Description:
This endpoint is used to delete SDK configurations for a specific site.
Success Response:
{
"message": "Sdk configurations deleted successfully."
}
* You can access the possible response codes you may encounter here.
Delete Sdk Configuration For Site
Endpoint:
DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/sdk-configurations/{key}
Description:
This endpoint is used to delete SDK configurations for a specific key with given clientIdentifier and siteIdentifier.
Success Response:
{
"message": "Sdk configurations deleted successfully."
}
* You can access the possible response codes you may encounter here.
Delete Sdk Configurations For Building
Endpoint:
DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/sdk-configurations
Description:
This endpoint is used to delete SDK configurations for a specific building.
Success Response:
{
"message": "Sdk configurations deleted successfully."
}
* You can access the possible response codes you may encounter here.
Delete Sdk Configuration For Building
Endpoint:
DELETE api/v9/content/draft/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/sdk-configurations/{key}
Description:
This endpoint is used to delete SDK configurations for a specific key with given clientIdentifier, siteIdentifier and buildingIdentifier.
Success Response:
{
"message": "Sdk configurations deleted successfully."
}
* You can access the possible response codes you may encounter here.