Taxonomy API Endpoints
Get Client Feature Types (Taxonomy)
Endpoint:
GET api/v9/content/draft/clients/{clientIdentifier}/taxonomies
GET api/v9/content/published/clients/{clientIdentifier}/taxonomies
Description:
Returns taxonomy details (feature types) for the specified client.
Success Response:
[
{
"tid": 0,
"typeCode": "undefined",
"typeName": "Undefined",
"description": "Unidentified POI types.",
"categories": "",
"isMapObject": true,
"shape": "polygon,point,line",
"class": "none",
"isWalkable": true,
"transitionDirection": null,
"transitionTravelTime": null,
"isTransitionAccessible": null,
"isTransitionComfortable": null,
"featureName": "unavailable",
"featureDescription": "unavailable"
},
{
"tid": 1,
"typeCode": "blueprint",
"typeName": "Blueprint",
"description": "Blueprint is a designated map layer to represent floor-plan on Pointr Cloud Dashboard.",
"categories": "",
"isMapObject": true,
"shape": "polygon,point,line",
"class": "none",
"isWalkable": true,
"transitionDirection": null,
"transitionTravelTime": null,
"isTransitionAccessible": null,
"isTransitionComfortable": null,
"featureName": "unavailable",
"featureDescription": "unavailable"
}
]
* You can access the possible response codes you may encounter here.
Update Client Feature Types (Taxonomy)
Endpoint:
PUT api/v9/content/draft/clients/{clientIdentifier}/taxonomies
Description:
Updates taxonomy details (feature types) for the specified client.
Validations
- TaxonomyUrl must be in url format and must be accessible.
- Request body must be in v9 taxonomy format and conform to schema rules. (Click here to view schema rules)
Request:
{
"taxonomyUrl": "https://pointrmapstorage.blob.core.windows.net/taxonomy/ptr_taxonomy_v9.json"
}
Success Response:
{
"message": "Taxonomy updated successfully."
}
Notes:
- In taxonomies update, previous records are deleted and new taxonomies are added.
* You can access the possible response codes you may encounter here.