MapFile
CRUD
| CRUD | Http Verb | Route | Description |
|---|---|---|---|
| READ | GET | /map/{id} | Retrieve a single MapFile from it's id |
| CREATE | POST | /map | Create a MapFile |
| UPDATE | POST | /map/{id} | Update a MapFile |
| DELETE | DELETE | /map/{id} | Delete a MapFile |
| SEARCH | GET | /map | Looking for MapFiles |
| BATCH DELETE | DELETE | /map | Delete multiple MapFiles |
Model
WARNING: This Model is the one retrieve using X-API-MODE="get" (see READ & SEARCH operations). So if you use the legacy one (standard), the model may differs on some fields.
CAUTION: MapFile is an abstract class, so you can't create a MapFile, you will always have to create an inherited entity of MapFile.
MapFile
| Field | Type | Readonly | Nullable | Translatable | Description |
|---|---|---|---|---|---|
| created_at | datetime(ISO 8601) |  |  | | Create datetime |
| file | File#id | | | | |
| id | int | | | | Identifier |
| name | string | | | | Name |
| site | Site#id | | | | Site identifier |
| type | string | | | | Discriminator value |
| updated_at | datetime(ISO 8601) | | | | Last updated datetime |
| version | int | | | | Revision version, it's incremented on each change |
Discriminator Map
| Discriminator Value | Class | Purpose |
|---|---|---|
| aoDae | MapAoDae | [Generated] The map data with ambiant occlusion in dae format |
| aoOsg | MapAoOsg | [Generated] The map data with ambiant occlusion in osg format |
| config | MapConfig | The map data config used in editor |
| dae | MapDae | The map data in dae format |
| helper | MapHelper | The map helper data used in editor |
| ive | MapIve | [Generated]The map data in ive format |
| light | MapLight | The legacy map format |
| osg | MapOsg | [Generated] The map data in osg format |
| path | MapPath | [Generated] The map paths |
MapAoDae
| Field | Type | Readonly | Nullable | Translatable | Description |
|---|
MapAoOsg
| Field | Type | Readonly | Nullable | Translatable | Description |
|---|
MapConfig
| Field | Type | Readonly | Nullable | Translatable | Description |
|---|
MapDae
| Field | Type | Readonly | Nullable | Translatable | Description |
|---|
MapHelper
| Field | Type | Readonly | Nullable | Translatable | Description |
|---|
MapIve
| Field | Type | Readonly | Nullable | Translatable | Description |
|---|
MapLight
| Field | Type | Readonly | Nullable | Translatable | Description |
|---|
MapOsg
| Field | Type | Readonly | Nullable | Translatable | Description |
|---|
MapPath
| Field | Type | Readonly | Nullable | Translatable | Description |
|---|---|---|---|---|---|
| paths | object | | | | The paths object |
| paths.nodes | array |  | | | List of nodes of the paths graph |
| paths.nodes[] | object | | | | A node element |
| paths.nodes[].groundId | int | | | | the groundId where the node belong to |
| paths.nodes[].id | int | | | | the node identifier, must be unique in that paths graph |
| paths.nodes[].isGate | boolean | | | | Indicate if the node is a gate or a simple one |
| paths.nodes[] .links | array | | | | List of links attached to that node |
| paths.nodes[].links[] | int | | | | Link identifier |
| paths.nodes[].location | object | | | | Reference the 3D data object where the node is placed |
| paths.nodes[].location.id | int | | | | The 3D data object identifier |
| paths.nodes.location.type | string | | | | The 3D data object type |
| paths.nodes[].position | object | | | | The position of the node in the 3D object system |
| paths.nodes[].position.x | float | | | | The x coordinate |
| paths.nodes[].position.y | float | | | | Y coordinate |
| paths.nodes[].position.z | float | | | | Z coordinate |
| paths.links | array | | | | List of links of the paths graph |
| paths.links[] | object | | | | A link |
| paths.links[].bidirectional | boolean | | | | Incate if the link could be browse in both ways |
| paths.links[].from | int | | | | The node identifier source |
| paths.links[].id | int | | | | The link unique identifier |
| paths.links[].to | int | | | | The target node identifier |
| paths.links[].type | int | | | | The link type: 0 for "NORMAL", 1 for "ONLY PRM", 2 for "NO PMR" and 3 for "DISABLED" |
| paths.links[].weight | int | | | | The weight given in that link to be considered on path resolution algorithme |
READ
Parameters
| Name | In | Type | Required | Default | Constraint | Description |
|---|---|---|---|---|---|---|
| id | Route | int | | | ||
| X-API-MODE | Header | string | | standard | "standard" or "get" | The "standard" mode is deprecated. Note that X-API-MODE will change serialization format. |
Responses
| Http Code | Description | Response type | Response Content | Note |
|---|---|---|---|---|
| 200 | Success | application/json | MapFile | The MapFile serialisation will differs depending on X-API-MODE |
| 400 | Invalid data | application/json | Error | |
| 403 | Authentication Error | application/json | Error | |
| 404 | Not Found | | | |
| 500 | Internal Server Error | application/json | Error | |
| 503 | Service Unavailable | | |
SEARCH
Parameters
| Name | In | Type | Required | Default | Constraint | Description |
|---|---|---|---|---|---|---|
| X-API-MODE | Header | string | | standard | "standard" or "get" | The "standard" mode is deprecated. Note that X-API-MODE will change serialization format. |
| name | Query | string | | | ||
| signature | Query | string | | | ||
| site | Query | int | | |
Responses
| Http Code | Description | Response type | Response Content | Note |
|---|---|---|---|---|
| 200 | Success | application/json | MapFile[] | The MapFile serialisation will differs depending on X-API-MODE |
| 400 | Invalid data | application/json | Error | |
| 403 | Authentication Error | application/json | Error | |
| 404 | Not Found | | | |
| 500 | Internal Server Error | application/json | Error | |
| 503 | Service Unavailable | | |