EU cookie consent script

API

Reference documentation

Features

The Features API to store points of interest and then retrieve their information. You can store, update or delete a feature using the appropriate method. Of course you can obtain its data using its identifier.

Store a feature

POST /osiris/geolocation/territory/feature

Parameters

Type

Name

Description

Required

Schema

Default

Header

api_key

Application identifier

true

string

Header

Authorization

Credentials formatted as Base64 of username:userpassword.
Example: Authorization: Basic eW91cl91c2VybmFtZTp5b3VyX3Bhc3N3b3Jk

true

string

Body

body

Feature

true

[FeatureDTO]

Responses

HTTP Code

Description

Schema

200

success

[FeatureDTO]

400

Invalid input parameter (header)

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • osirisgeolocationterritoryfeature

Delete a feature

DELETE /osiris/geolocation/territory/feature/{idFeature}

Parameters

Type

Name

Description

Required

Schema

Default

Header

api_key

Application identifier

true

string

Header

Authorization

Credentials formatted as Base64 of username:userpassword.
Example: Authorization: Basic eW91cl91c2VybmFtZTp5b3VyX3Bhc3N3b3Jk

true

string

Path

idFeature

Feature identifier

true

string

Responses

HTTP Code

Description

Schema

204

Feature was deleted

No Content

404

Feature was not found

No Content

400

Invalid input parameter (header)

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • osirisgeolocationterritoryfeature

Update a feature

PUT /osiris/geolocation/territory/feature/{idFeature}

Parameters

Type

Name

Description

Required

Schema

Default

Header

api_key

Application identifier

true

string

Header

Authorization

Credentials formatted as Base64 of username:userpassword.
Example: Authorization: Basic eW91cl91c2VybmFtZTp5b3VyX3Bhc3N3b3Jk

true

string

Path

idFeature

Feature identifier

true

string

Body

body

Updated feature

true

[FeatureDTO]

Responses

HTTP Code

Description

Schema

404

Feature was not found

No Content

200

success

[FeatureDTO]

400

Invalid input parameter (header)

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • osirisgeolocationterritoryfeature

Get a feature by id

GET /osiris/geolocation/territory/feature/{idFeature}

Parameters

Type

Name

Description

Required

Schema

Default

Header

api_key

Application identifier

true

string

Header

Authorization

Credentials formatted as Base64 of username:userpassword.
Example: Authorization: Basic eW91cl91c2VybmFtZTp5b3VyX3Bhc3N3b3Jk

true

string

Path

idFeature

Feature identifier

true

string

Responses

HTTP Code

Description

Schema

404

Feature was not found

No Content

200

success

[FeatureDTO]

400

Invalid input parameter (header)

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • osirisgeolocationterritoryfeature

File

The File API provides a method to obtain the map file you can use with Mapsforge component

Get .map file

GET /osiris/geolocation/territory/map/file

Parameters

Type

Name

Description

Required

Schema

Default

Header

api_key

Application identifier

true

string

Header

Authorization

Credentials formatted as Base64 of username:userpassword.
Example: Authorization: Basic eW91cl91c2VybmFtZTp5b3VyX3Bhc3N3b3Jk

true

string

Responses

HTTP Code

Description

Schema

404

.map file was not found

No Content

200

success

java.io.InputStream

400

Invalid input parameter (header)

No Content

Tags

  • osirisgeolocationterritorymapfile

Metadata

Used to get the meta data of the map which is useful to know if there is a newer version uploaded to the server.

Get metadata of map

GET /osiris/geolocation/territory/map/metadata

Parameters

Type

Name

Description

Required

Schema

Default

Header

api_key

Application identifier

true

string

Header

Authorization

Credentials formatted as Base64 of username:userpassword.
Example: Authorization: Basic eW91cl91c2VybmFtZTp5b3VyX3Bhc3N3b3Jk

true

string

Responses

HTTP Code

Description

Schema

200

success

[MetaDataDTO]

400

Metadata of map was not found

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • osirisgeolocationterritorymapmetadata

Search

Using Search you can get the features (points of interest) or the geometries to draw the building parts in your application.p>

Get data according to query

POST /osiris/geolocation/territory/search

Parameters

Type

Name

Description

Required

Schema

Default

Header

api_key

Application identifier

true

string

Header

Authorization

Credentials formatted as Base64 of username:userpassword.
Example: Authorization: Basic eW91cl91c2VybmFtZTp5b3VyX3Bhc3N3b3Jk

true

string

Body

body

Query

true

string

QueryParameter

layer

Layer

false

enum (ALL, MAP, FEATURES)

ALL

QueryParameter

pageIndex

Index of page

false

integer (int32)

0

QueryParameter

pageSize

Size of page

false

integer (int32)

20

QueryParameter

orderField

Order field

false

string

QueryParameter

order

Order

false

enum (ASC, DESC)

ASC

Responses

HTTP Code

Description

Schema

200

success

[FeatureDTO] array

400

Query is not correct

No Content

Consumes

  • application/json

Produces

  • application/json

Tags

  • osirisgeolocationterritorysearch

Definitions

FeatureDTO

Name Description Required Schema Default

properties

Set of properties

false

string

id

Id of feature

false

string

propertiesRelations

Parents properties

false

string

geometryDTO

Geometry of feature

true

GeometryDTO

MetaDataDTO

Name Description Required Schema Default

oSMChecksum

false

string

routingChecksum

Checksum of routing file

true

string

maxLatitude

Maximum latitude of map

false

string

maxLongitude

Maximum longitude of map

false

string

minLongitude

Minimum longitude of map

false

string

minLatitude

Minimum latitude of map

false

string

appId

Application identifier of map

true

string