Utilitarian API (1.3.0)

Download OpenAPI specification:Download

Utilitarian API is a software for Multi Utility AMR (Automatic Meter Reading) built by Palmlund Wahlgren Innovative Technology AB and is targeted to utility organisations that require a more open solution for their AMR Operations.

The source for this documentation can be found on github.com. If you find any errors in the documentation or you have suggestions on how to make it better please create an issue on Github.

Introduction

Utilitarian API is a RESTful API that exposes endpoint for AMR Operations.

Authentication

Token Authentication

Each user with is_staff=True is given a unique API Key Token to interact with the API.

Token Authentication is made for programatical high level access of the API. To make other services use the API via a Token make a sepatate user for them and use the token in all authentications.

Users with Token Authentication access to all actions in the API.

For clients to authenticate, the token key should be included in the Authorization HTTP header. The key should be prefixed by the string literal "Token", with whitespace separating the two strings. For example:

Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b

Unauthenticated responses that are denied permission will result in an HTTP 401 Unauthorized response with an appropriate WWW-Authenticate header. For example:

WWW-Authenticate: Token

Note: If you are running an instance of Utilitarian API that is accessable over the Internet you need to make sure that the API is only served under https.

User JWT Auth

Users with is_staff=False are able to request a JSON Web Token (JWT) via the /auth/jwt endpoints.

The JWT endpoint issues a JWT with only read access to the API and will filter all results to the entites the users organization has access to. When using User JWT Auth the organization field of all request bodys an be omittted and if you add it in the request body it will be cleaned and the correct organization ID will be added. For users that are part of several organizations it is possible to switch organization by requesting a new JWT for another organization.

User JWT Auth is used for client applications using the API. Mobile apps, single page application etc.

For clients to authenticate, the JWT key should be included in the Authorization HTTP header. The key should be prefixed by the string literal "JWT", with whitespace separating the two strings. For example:

Authorization: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Unauthenticated responses that are denied permission will result in an HTTP 401 Unauthorized response with an appropriate WWW-Authenticate header. For example:

WWW-Authenticate: JWT

Note: If you are running an instance of Utilitarian API that is accessable over the Internet you need to make sure that the API is only served under https.

Pagination

The Pagination scheme used for Utiltiarian API is a Limit/Offset scheme.

By using a limit indicates the maximum number of items to return and the offset indicates the starting position of the query in relation to the complete set of unpaginated items. This makes for a very extensible pagination scheme where the client have better control of the returned values. In all responses the total count of items in the compleate set of unpaginated items are returned to be able to know where in the set a pagination response is located.

The limit and offset is applied in query parameters like:

GET https://api.example.org/accounts/?limit=100&offset=400

The following example shows a common result set.

{
  "count": 1023
  "next": "https://api.example.org/accounts/?limit=100&offset=500",
  "previous": "https://api.example.org/accounts/?limit=100&offset=300",
  "results": []
}

Note: Having very large result sets can lead to significant performance issues.

Meter Devices

Operations on Meter Devices

Meter Devices

Meter Devices are the entity that represents a physical (or logical) meter deployed in the field. They handle all information about how to communicate with the meter and how to interpret the data from the meter.

metering_meter-devices_list

get /metering/meter-devices
/v1/metering/metering/meter-devices

Returns a list of MeterDevices

query Parameters
name
string
external_system_reference
string
manufacturer_serial
string
dlms_logical_device_name
string
dlms_system_title
string
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

200

OK

Response samples

application/json
Copy
Expand all Collapse all
{
  • "count": 0,
  • "previous": "http://example.com",
  • "results":
    [
    ]
}

metering_meter-devices_create

post /metering/meter-devices
/v1/metering/metering/meter-devices

Creates a MeterDevice

Request Body schema: application/json
organization
string <uuid> (Organization) Nullable
name
required
string (Unique name or identification) [ 1 .. 50 ] characters
external_system_reference
string (External system reference) <= 50 characters Nullable
manufacturer_serial
string (Serial number from manufacturer) <= 50 characters Nullable
protocol
required
string (Communication protocol)
Enum:"dlms-cosem" "iec62056-21" "i-flag" "mbus" "modbus" "lis-200"
iec62056_21_address
string (IEC62056-21 meter address) <= 8 characters Nullable

Only used for IEC62056-21 communication

dlms_logical_device_name
string (DLMS Logical Device Name) <= 32 characters Nullable ^[abcdefABCDEF1234567890]*$

Only used for DLMS communication

dlms_system_title
string (DLMS System Title) <= 16 characters Nullable ^[abcdefABCDEF1234567890]*$

Only used for DLMS communication

type
string <uuid> (Type) Nullable
task_groups
Array of string <uuid> (AMR Task Groups)

Choose AMR Task Groups the meter device should be a part of.

meter_tasks
Array of string <uuid> (AMR Tasks)

Choose AMR Tasks that are just for this meter device.

network_interface
string <uuid> (Network interface) Nullable
has_current_transformer
boolean (Has current transformer)

Indicates if the meter has a current transformer in its measurement loop.

current_transformer_ratio
integer (Current transformer ratio) [ -2147483648 .. 2147483647 ]

The ratio of the current transformer, Ex: 150/5 = 30

has_voltage_transformer
boolean (Has voltage transformer)

Indicates if the meter has a voltage transformer in its measurement loop.

voltage_transformer_ratio
integer (Voltage transformer ratio) [ -2147483648 .. 2147483647 ]

The ratio of the voltage transformer, Ex: 150/5 = 30

has_disconnector
boolean (Has disconnector)

indicates if the meter device has a disconnector

disconnector_status
integer (Disconnector status) Nullable
Enum:0 1 2

Responses

201

Created

Request samples

application/json
Copy
Expand all Collapse all
{
  • "organization": "string",
  • "name": "string",
  • "external_system_reference": "string",
  • "manufacturer_serial": "string",
  • "protocol": "dlms-cosem",
  • "iec62056_21_address": "string",
  • "dlms_logical_device_name": "string",
  • "dlms_system_title": "string",
  • "type": "string",
  • "task_groups":
    [
    ],
  • "meter_tasks":
    [
    ],
  • "network_interface": "string",
  • "has_current_transformer": true,
  • "current_transformer_ratio": -2147483648,
  • "has_voltage_transformer": true,
  • "voltage_transformer_ratio": -2147483648,
  • "has_disconnector": true,
  • "disconnector_status": 0
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organization": "string",
  • "name": "string",
  • "external_system_reference": "string",
  • "manufacturer_serial": "string",
  • "protocol": "dlms-cosem",
  • "iec62056_21_address": "string",
  • "dlms_logical_device_name": "string",
  • "dlms_system_title": "string",
  • "type": "string",
  • "task_groups":
    [
    ],
  • "meter_tasks":
    [
    ],
  • "network_interface": "string",
  • "network_interface_info": "string",
  • "has_current_transformer": true,
  • "current_transformer_ratio": -2147483648,
  • "has_voltage_transformer": true,
  • "voltage_transformer_ratio": -2147483648,
  • "has_disconnector": true,
  • "disconnector_status": 0,
  • "created_at": "2020-01-20T15:54:22Z",
  • "updated_at": "2020-01-20T15:54:22Z"
}

metering_meter-devices_read

get /metering/meter-devices/{id}
/v1/metering/metering/meter-devices/{id}

Returns a single MeterDevice

path Parameters
id
required
string <uuid>

A UUID string identifying this meter device.

Responses

200

OK

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organization": "string",
  • "name": "string",
  • "external_system_reference": "string",
  • "manufacturer_serial": "string",
  • "protocol": "dlms-cosem",
  • "iec62056_21_address": "string",
  • "dlms_logical_device_name": "string",
  • "dlms_system_title": "string",
  • "type": "string",
  • "task_groups":
    [
    ],
  • "meter_tasks":
    [
    ],
  • "network_interface": "string",
  • "network_interface_info": "string",
  • "has_current_transformer": true,
  • "current_transformer_ratio": -2147483648,
  • "has_voltage_transformer": true,
  • "voltage_transformer_ratio": -2147483648,
  • "has_disconnector": true,
  • "disconnector_status": 0,
  • "created_at": "2020-01-20T15:54:22Z",
  • "updated_at": "2020-01-20T15:54:22Z"
}

metering_meter-devices_update

put /metering/meter-devices/{id}
/v1/metering/metering/meter-devices/{id}

Updates a single MeterDevice

path Parameters
id
required
string <uuid>

A UUID string identifying this meter device.

Request Body schema: application/json
organization
string <uuid> (Organization) Nullable
name
required
string (Unique name or identification) [ 1 .. 50 ] characters
external_system_reference
string (External system reference) <= 50 characters Nullable
manufacturer_serial
string (Serial number from manufacturer) <= 50 characters Nullable
protocol
required
string (Communication protocol)
Enum:"dlms-cosem" "iec62056-21" "i-flag" "mbus" "modbus" "lis-200"
iec62056_21_address
string (IEC62056-21 meter address) <= 8 characters Nullable

Only used for IEC62056-21 communication

dlms_logical_device_name
string (DLMS Logical Device Name) <= 32 characters Nullable ^[abcdefABCDEF1234567890]*$

Only used for DLMS communication

dlms_system_title
string (DLMS System Title) <= 16 characters Nullable ^[abcdefABCDEF1234567890]*$

Only used for DLMS communication

type
string <uuid> (Type) Nullable
task_groups
Array of string <uuid> (AMR Task Groups)

Choose AMR Task Groups the meter device should be a part of.

meter_tasks
Array of string <uuid> (AMR Tasks)

Choose AMR Tasks that are just for this meter device.

network_interface
string <uuid> (Network interface) Nullable
has_current_transformer
boolean (Has current transformer)

Indicates if the meter has a current transformer in its measurement loop.

current_transformer_ratio
integer (Current transformer ratio) [ -2147483648 .. 2147483647 ]

The ratio of the current transformer, Ex: 150/5 = 30

has_voltage_transformer
boolean (Has voltage transformer)

Indicates if the meter has a voltage transformer in its measurement loop.

voltage_transformer_ratio
integer (Voltage transformer ratio) [ -2147483648 .. 2147483647 ]

The ratio of the voltage transformer, Ex: 150/5 = 30

has_disconnector
boolean (Has disconnector)

indicates if the meter device has a disconnector

disconnector_status
integer (Disconnector status) Nullable
Enum:0 1 2

Responses

200

OK

Request samples

application/json
Copy
Expand all Collapse all
{
  • "organization": "string",
  • "name": "string",
  • "external_system_reference": "string",
  • "manufacturer_serial": "string",
  • "protocol": "dlms-cosem",
  • "iec62056_21_address": "string",
  • "dlms_logical_device_name": "string",
  • "dlms_system_title": "string",
  • "type": "string",
  • "task_groups":
    [
    ],
  • "meter_tasks":
    [
    ],
  • "network_interface": "string",
  • "has_current_transformer": true,
  • "current_transformer_ratio": -2147483648,
  • "has_voltage_transformer": true,
  • "voltage_transformer_ratio": -2147483648,
  • "has_disconnector": true,
  • "disconnector_status": 0
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organization": "string",
  • "name": "string",
  • "external_system_reference": "string",
  • "manufacturer_serial": "string",
  • "protocol": "dlms-cosem",
  • "iec62056_21_address": "string",
  • "dlms_logical_device_name": "string",
  • "dlms_system_title": "string",
  • "type": "string",
  • "task_groups":
    [
    ],
  • "meter_tasks":
    [
    ],
  • "network_interface": "string",
  • "network_interface_info": "string",
  • "has_current_transformer": true,
  • "current_transformer_ratio": -2147483648,
  • "has_voltage_transformer": true,
  • "voltage_transformer_ratio": -2147483648,
  • "has_disconnector": true,
  • "disconnector_status": 0,
  • "created_at": "2020-01-20T15:54:22Z",
  • "updated_at": "2020-01-20T15:54:22Z"
}

metering_meter-devices_partial_update

patch /metering/meter-devices/{id}
/v1/metering/metering/meter-devices/{id}

Partially updates a single MeterDevice

path Parameters
id
required
string <uuid>

A UUID string identifying this meter device.

Request Body schema: application/json
organization
string <uuid> (Organization) Nullable
name
required
string (Unique name or identification) [ 1 .. 50 ] characters
external_system_reference
string (External system reference) <= 50 characters Nullable
manufacturer_serial
string (Serial number from manufacturer) <= 50 characters Nullable
protocol
required
string (Communication protocol)
Enum:"dlms-cosem" "iec62056-21" "i-flag" "mbus" "modbus" "lis-200"
iec62056_21_address
string (IEC62056-21 meter address) <= 8 characters Nullable

Only used for IEC62056-21 communication

dlms_logical_device_name
string (DLMS Logical Device Name) <= 32 characters Nullable ^[abcdefABCDEF1234567890]*$

Only used for DLMS communication

dlms_system_title
string (DLMS System Title) <= 16 characters Nullable ^[abcdefABCDEF1234567890]*$

Only used for DLMS communication

type
string <uuid> (Type) Nullable
task_groups
Array of string <uuid> (AMR Task Groups)

Choose AMR Task Groups the meter device should be a part of.

meter_tasks
Array of string <uuid> (AMR Tasks)

Choose AMR Tasks that are just for this meter device.

network_interface
string <uuid> (Network interface) Nullable
has_current_transformer
boolean (Has current transformer)

Indicates if the meter has a current transformer in its measurement loop.

current_transformer_ratio
integer (Current transformer ratio) [ -2147483648 .. 2147483647 ]

The ratio of the current transformer, Ex: 150/5 = 30

has_voltage_transformer
boolean (Has voltage transformer)

Indicates if the meter has a voltage transformer in its measurement loop.

voltage_transformer_ratio
integer (Voltage transformer ratio) [ -2147483648 .. 2147483647 ]

The ratio of the voltage transformer, Ex: 150/5 = 30

has_disconnector
boolean (Has disconnector)

indicates if the meter device has a disconnector

disconnector_status
integer (Disconnector status) Nullable
Enum:0 1 2

Responses

200

OK

Request samples

application/json
Copy
Expand all Collapse all
{
  • "organization": "string",
  • "name": "string",
  • "external_system_reference": "string",
  • "manufacturer_serial": "string",
  • "protocol": "dlms-cosem",
  • "iec62056_21_address": "string",
  • "dlms_logical_device_name": "string",
  • "dlms_system_title": "string",
  • "type": "string",
  • "task_groups":
    [
    ],
  • "meter_tasks":
    [
    ],
  • "network_interface": "string",
  • "has_current_transformer": true,
  • "current_transformer_ratio": -2147483648,
  • "has_voltage_transformer": true,
  • "voltage_transformer_ratio": -2147483648,
  • "has_disconnector": true,
  • "disconnector_status": 0
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organization": "string",
  • "name": "string",
  • "external_system_reference": "string",
  • "manufacturer_serial": "string",
  • "protocol": "dlms-cosem",
  • "iec62056_21_address": "string",
  • "dlms_logical_device_name": "string",
  • "dlms_system_title": "string",
  • "type": "string",
  • "task_groups":
    [
    ],
  • "meter_tasks":
    [
    ],
  • "network_interface": "string",
  • "network_interface_info": "string",
  • "has_current_transformer": true,
  • "current_transformer_ratio": -2147483648,
  • "has_voltage_transformer": true,
  • "voltage_transformer_ratio": -2147483648,
  • "has_disconnector": true,
  • "disconnector_status": 0,
  • "created_at": "2020-01-20T15:54:22Z",
  • "updated_at": "2020-01-20T15:54:22Z"
}

metering_meter-devices_delete

delete /metering/meter-devices/{id}
/v1/metering/metering/meter-devices/{id}

Deletes a single MeterDevice

path Parameters
id
required
string <uuid>

A UUID string identifying this meter device.

Responses

204

No Content

Network Interfaces

Operations on Network Interfaces.

Network Interfaces

A NetworkInterface is an object holding information needed for communication to a meter device. You can connect SIM cards to a network interface. Several meter devices can share the same network interface, for example an MBus gateway. It is also possbile for several network interfaces to share the same SIM Card, for example if using the same IP/SIM-card but different devices are under different ports. Then each meter device would have its own network interface specifiying the port but they would all share the same SIM Card to get the IP address.

Some network interfaces only allows for one open connection and when the network interface is used by communication software we want to make sure that no other job is trying to communicate with the meter devcice. This is done by blocking the network interface. When the communication is done the network interface should be unblocked so that other jobs can connect to it.

Tips: The host parameter is only returned in responses and will contain the following data:

  1. FQDN. If a meter has a DNS compliant name attached to it we assume we want to use that firstly
  2. Static IP Address. If no FQDN is set on the meter it will return the static ip address associated with it.
  3. IP of SIM Card. If no static ip address or FQDN is set the meter will return the IP of the SIM Card attached to it.

metering_network-interfaces_list

get /metering/network-interfaces
/v1/metering/metering/network-interfaces

returns list of NetworkInterfaces

query Parameters
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

200

OK

Response samples

application/json
Copy
Expand all Collapse all
{
  • "count": 0,
  • "previous": "http://example.com",
  • "results":
    [
    ]
}

metering_network-interfaces_create

post /metering/network-interfaces
/v1/metering/metering/network-interfaces

Create a new Network Interface

Request Body schema: application/json
organization
required
string <uuid> (Organization)
static_ip_address
string (Static IP address) non-empty Nullable

Will override any IP that might be incurred from SIM. Could be used on physical connections such as LAN or when not storing SIMs in Utilitarian.

fqdn
string (FQDN) <= 200 characters Nullable

Will override any set IP and use DNS to lookup IP of meters. Ex: meter098765.mydomain.com .

port
integer (Port) [ 0 .. 2147483647 ] Nullable

Port used for IP communication.

sim
string <uuid> (Sim) Nullable
can_block
boolean (Can block)

It is possible to block the network interface.

Responses

201

Created

Request samples

application/json
Copy
Expand all Collapse all
{
  • "organization": "string",
  • "static_ip_address": "string",
  • "fqdn": "string",
  • "port": 0,
  • "sim": "string",
  • "can_block": true
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organization": "string",
  • "static_ip_address": "string",
  • "host": "string",
  • "fqdn": "string",
  • "port": 0,
  • "sim": "string",
  • "can_block": true,
  • "is_blocked": true,
  • "block_time": "2020-01-20T15:54:22Z",
  • "created_at": "2020-01-20T15:54:22Z",
  • "updated_at": "2020-01-20T15:54:22Z"
}

metering_network-interfaces_read

get /metering/network-interfaces/{id}
/v1/metering/metering/network-interfaces/{id}

Returns a single NetworkInterface

path Parameters
id
required
string <uuid>

A UUID string identifying this network interface.

Responses

200

OK

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organization": "string",
  • "static_ip_address": "string",
  • "host": "string",
  • "fqdn": "string",
  • "port": 0,
  • "sim": "string",
  • "can_block": true,
  • "is_blocked": true,
  • "block_time": "2020-01-20T15:54:22Z",
  • "created_at": "2020-01-20T15:54:22Z",
  • "updated_at": "2020-01-20T15:54:22Z"
}

metering_network-interfaces_update

put /metering/network-interfaces/{id}
/v1/metering/metering/network-interfaces/{id}

Updates a single Network Interface

path Parameters
id
required
string <uuid>

A UUID string identifying this network interface.

Request Body schema: application/json
organization
required
string <uuid> (Organization)
static_ip_address
string (Static IP address) non-empty Nullable

Will override any IP that might be incurred from SIM. Could be used on physical connections such as LAN or when not storing SIMs in Utilitarian.

fqdn
string (FQDN) <= 200 characters Nullable

Will override any set IP and use DNS to lookup IP of meters. Ex: meter098765.mydomain.com .

port
integer (Port) [ 0 .. 2147483647 ] Nullable

Port used for IP communication.

sim
string <uuid> (Sim) Nullable
can_block
boolean (Can block)

It is possible to block the network interface.

Responses

200

OK

Request samples

application/json
Copy
Expand all Collapse all
{
  • "organization": "string",
  • "static_ip_address": "string",
  • "fqdn": "string",
  • "port": 0,
  • "sim": "string",
  • "can_block": true
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organization": "string",
  • "static_ip_address": "string",
  • "host": "string",
  • "fqdn": "string",
  • "port": 0,
  • "sim": "string",
  • "can_block": true,
  • "is_blocked": true,
  • "block_time": "2020-01-20T15:54:22Z",
  • "created_at": "2020-01-20T15:54:22Z",
  • "updated_at": "2020-01-20T15:54:22Z"
}

metering_network-interfaces_partial_update

patch /metering/network-interfaces/{id}
/v1/metering/metering/network-interfaces/{id}

Partially updates a single Network Interface

path Parameters
id
required
string <uuid>

A UUID string identifying this network interface.

Request Body schema: application/json
organization
required
string <uuid> (Organization)
static_ip_address
string (Static IP address) non-empty Nullable

Will override any IP that might be incurred from SIM. Could be used on physical connections such as LAN or when not storing SIMs in Utilitarian.

fqdn
string (FQDN) <= 200 characters Nullable

Will override any set IP and use DNS to lookup IP of meters. Ex: meter098765.mydomain.com .

port
integer (Port) [ 0 .. 2147483647 ] Nullable

Port used for IP communication.

sim
string <uuid> (Sim) Nullable
can_block
boolean (Can block)

It is possible to block the network interface.

Responses

200

OK

Request samples

application/json
Copy
Expand all Collapse all
{
  • "organization": "string",
  • "static_ip_address": "string",
  • "fqdn": "string",
  • "port": 0,
  • "sim": "string",
  • "can_block": true
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organization": "string",
  • "static_ip_address": "string",
  • "host": "string",
  • "fqdn": "string",
  • "port": 0,
  • "sim": "string",
  • "can_block": true,
  • "is_blocked": true,
  • "block_time": "2020-01-20T15:54:22Z",
  • "created_at": "2020-01-20T15:54:22Z",
  • "updated_at": "2020-01-20T15:54:22Z"
}

metering_network-interfaces_delete

delete /metering/network-interfaces/{id}
/v1/metering/metering/network-interfaces/{id}

Deletes a single Network Interface

path Parameters
id
required
string <uuid>

A UUID string identifying this network interface.

Responses

204

No Content

SIM Cards

Operations on SIM Cards

SIM Cards

Utilitarian is focused on IP communication with meters. Many meter have internal or external modems that are used for cellular communications. This require a SIM-card. Many SIM-cards in IoT data plans will give a fixed IP. It is possible to store all your SIM cards in Utiltarian and link them to your meter devices for an easy way of finding the IP for a meter device. If you switch a SIM cards in the field you need to switch it in Utilitarian so that the system can find the meter device.

Tips: It is possible to save a link to the managing software, for example Jasper, of the SIM cards. In future Utilitarian UI this will be rendered as an external link to quickly get access to logs and other SIM cards operations that are not in the scope of Utilitarian.

metering_sim-cards_list

get /metering/sim-cards
/v1/metering/metering/sim-cards

Returns a list of SimCards

query Parameters
iccid
string
imsi
string
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

Responses

200

OK

Response samples

application/json
Copy
Expand all Collapse all
{
  • "count": 0,
  • "previous": "http://example.com",
  • "results":
    [
    ]
}

metering_sim-cards_create

post /metering/sim-cards
/v1/metering/metering/sim-cards

Creates a new SimCard

Request Body schema: application/json
organization
string <uuid> (Organization) Nullable
iccid
required
string (ICCID) [ 1 .. 20 ] characters ^[0123456789]*$
imsi
required
string (IMSI) [ 1 .. 15 ] characters ^[0123456789]*$
ip_address
string (IP address) non-empty Nullable
phone_number
string (Telephone number) [ 1 .. 30 ] characters Nullable
external_system_link
string <uri> (External system link) [ 1 .. 200 ] characters Nullable

Link to external system for management of the SIM

Responses

201

Created

Request samples

application/json
Copy
Expand all Collapse all
{
  • "organization": "string",
  • "iccid": "string",
  • "imsi": "string",
  • "ip_address": "string",
  • "phone_number": "string",
  • "external_system_link": "http://example.com"
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organization": "string",
  • "iccid": "string",
  • "imsi": "string",
  • "ip_address": "string",
  • "phone_number": "string",
  • "external_system_link": "http://example.com",
  • "created_at": "2020-01-20T15:54:22Z",
  • "updated_at": "2020-01-20T15:54:22Z"
}

metering_sim-cards_read

get /metering/sim-cards/{id}
/v1/metering/metering/sim-cards/{id}

Returns a single SimCard

path Parameters
id
required
string <uuid>

A UUID string identifying this sim card.

Responses

200

OK

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "organization": "string",
  • "iccid": "string",
  • "imsi": "string",
  • "ip_address": "string",
  • "phone_number": "string"</