-
Notifications
You must be signed in to change notification settings - Fork 3
SMK API Details
The Simple Map Kit Map Configuration and Creation Service (SMKS-API) is a RESULTful service for assisting with the creation and management of map configuration resources used by the SMK Client javascript application.
The Service API is used by the SMK Admin UI, and the client in standalone mode. When a Map Configuration is exported, the service is no longer needed and your application will not connect back to it.
The SMK API Service tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.
| Verb | Usage |
|---|---|
|
Used to retrieve a resource or list of resources |
|
Used to create a new resource |
|
Used to update an existing resource |
|
Used to delete an existing resource |
The SMK API service tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.
| Status code | Usage |
|---|---|
|
Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action. |
|
The request has been fulfilled and resulted in a new resource being created. |
|
The server successfully processed the request, but is not returning any content. |
|
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). |
|
The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible. |
| Type | Link | Description |
|---|---|---|
|
Create a new Map Configuration |
|
|
Fetch a listing of all existing edit version map configurations. Published configurations will not be returned |
|
|
Fetch a map configuration document by ID. This will return the current editable version of a configuration. This will not return a published config |
|
|
Update an editable (unpublished) map configuration document |
|
|
Delete an editable (unpublished) map configuration document |
| Type | Link | Description |
|---|---|---|
|
Publish a Map Configuration |
|
|
Fetch a listing of all existing published map configurations. Editable configurations will not be returned |
|
|
Fetch a published map configuration document by ID. This will return the current published version of a configuration. This will not return an edited config |
|
|
Un-publish a published map configuration. This will not delete the existing editable configuration |
| Type | Link | Description |
|---|---|---|
|
Create a new attachment for a map configuration |
|
|
Replace an existing attachment with a new attachment document |
|
|
Fetch a listing of all existing map configuration attachments, including vector layers, custom markers, and header image |
|
|
Fetch a map configuration attachment by ATTACHMENT ID |
|
|
Permenantly delete a map configurations attachment |
|
Note
|
published documents also include Attachment endpoints, but only the GET methods are available. They follow the same rules and structure as editable map configuration documents. |
Complete resource model details can be found here