Provisioning-API

An API to serve the Provisioning GUI

Boxes

Create a new box

POST /boxes/create

Replace a box with a new or existing box

POST /boxes/create

Get all assigned boxes for the current user

GET /boxes/all

Get all unassigned boxes for the current user

GET /boxes/all

Get a box by it's id

GET /boxes/{id}

Get all meters for a box

GET /boxes/{id}/meters

Update an existing box

PUT /boxes/{id}

Upgrade the status of a box

PATCH /boxes/{id}/status-upgrade

Update the date of a box configuration

PATCH /boxes/{id}/config-update

Tag a box for re-configuration

PATCH /boxes/{id}/config-start

Delete an existing box

DELETE /boxes/{id}

Buildings

Get all buildings for the current user

GET /buildings/all

Get a building by it's id

GET /buildings/{id}

Get all boxes for a building

GET /buildings/{id}/boxes

Get all config ports for a building

GET /buildings/{id}/config-ports

Clients

Get client for current user

GET /clients

Config Ports

Get all available config port for a user

GET /config-ports/all

Measurements

Create a measurement

POST /measurements/{id}

Get all assigned measurements for the current user

GET /measurements/all

Get all unassigned measurements for the current user

GET /measurements/stock

Get a measurement by its id

GET /measurements/{id}

Update an existing measurement

PUT /measurements/{id}

Delete a measurement

DELETE /measurements/{id}

Meter Models

Get all models

GET /meter-models/all

Get the number of default measurements for a model

GET /meter-models/{id}/count-default-measurements

Meters

Create a new meter

POST /meters/{id}/create

Get all assigned meters for the current user

GET /meters/all

Get all unassigned meters for the current user

GET /meters/stock

Get a meter by it's id

GET /meters/{id}

Get all measurements for a meter

GET /meters/{id}/measurements

Update an existing meter

PUT /meters/{id}

Upgrade the status of a meter

PATCH /meters/{id}/status-upgrade

Delete a meter

DELETE /meters/{id}

Model Types

Get all model types

GET /model-types/all

OBIS Codes

Get all OBIS codes

GET /obis-codes/all

Status

Get all statuses

GET /statuses/all

Types of Interface

Get all interface types

GET /interface-types/all

Units

Get all units

GET /units/all

Users

Register a new user

POST /users/register

Login to application and receive user object with token

POST /users/login

Login to application using JWT token

POST /users/session