Place Editor
GET /editor/url/places/{placeId} #
Returns a URL that opens a map in the ContentTools user interface where you can view and edit a custom Place. The Place you want to view is identified in the request by its placeId.
Request #
Authorization: bearer {token}
Parameter:
| Name | Description | Data Type |
|---|---|---|
expirationInHours
| (Optional) Sets an expiration in hours for the URL in the response. Can take values between 1 to 6 (hours). By default, the expiration is set to 6 hours. |
Int |
Response #
| Name | Description | Data Type |
|---|---|---|
url
| URL to view & edit the place in ContentTools |
String |
expires
| The date and time at which the URL is set to expire |
DateTime |
Sample Response #
{
"data": [
{
"url": "https://contenttools.alk.com/place-editor/autologin/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvaWQiOiIyNDAiLCJleHAiOjE1NjU3MDkwODIsIm5iZiI6MTU2NTcwNTQ4MiwiaWF0IjoxNTY1NzA1NDgyfQ.xbDiaSoGC0M7300N_o9VK108FuP1yOp48JYid6zQnEc/10552316",
"expires": "2019-08-13T15:11:22.2590954+00:00"
}
]
}
Sample Error Response #
{
"errors": [
{
"ErrorType": "DataAccessException",
"Description": "Cannot find Item with supplied id",
"ErrorCode": "-1"
}
]
}
Error Codes #
| Message | Description |
|---|---|
| ArgumentException / Invalid Item Identifier - must be greater than zero | placeId is not a valid positive integer |
| BadRequest / expirationInHours must be a positive integer of at most 6 | expirationInHours is out-of-bounds |
| DataAccessException / Cannot find Item with supplied id | The specified place does not exist or has been deleted |
| DataAccessException / You do not have access to the Item with the specified id | The specified place exists, but does not belong to your account |