open_api_spec.yaml

swagger: '2.0'
info:
  title: Utilitarian API

  termsOfService: https://www.pwit.se
  x-logo:
    url: "https://docs.utilitarian.io/images/utilitarian_logo_on_light.svg"
    backgroundColor: "#FFFFFF"
    altText: "Utilitarian logo"
  contact:
    name: Dev Team
    url: https://www.utilitarian.io
    email: info@pwit.se
  version: 1.3.0
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  description: |
    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](https://www.github.com/pwitab/utilitarian-api-docs). 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.


host: localhost
schemes:
  - https
basePath: /v1/metering  # Maybe this should be changed??
consumes:
  - application/json
produces:
  - application/json

securityDefinitions:
  api_key:
    name: API Key
    description: >
      Each User is given an API Key.
    type: apiKey
    in: header

  basic:
    description: >
      All users are allowed to use basic auth but it is not recommended.
    type: basic
    name: basic
    in: header

tags:
  # Metering
  - name: meter-devices
    description: |
      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.


    x-displayName: Meter Devices

  - name: meter-device-configs
    description: |
      Operations on Meter Device Configs

      ### Meter Device Configs

      A Meter Device Config stores the configurations of a Meter Device Type.
      As of now this stores mainly what MeteringSeries it has.
      The metering series list is used to validate if a meter reading from a
      meter device is allowed to be saved.

      The plan later on is have information about what, for example COSEM
      objects a meter has, or what MBus Vifes etc the meter has. For example can
      an IDIS complient meter share configuration with other meters of different
      make. An OMS compliant Mbus meter can also share configuration between
      different manufacturers.


    x-displayName: Meter Device Configs

  - name: meter-device-types
    description: |
      Operations on Meter Device Types

      ### Meter Device Types

      It is possible to have a meter that is of same make and model but
      differently configured. By adding a different meter type we can have a
      several different setups of the same manufacturer model.

    x-displayName: Meter Device Types

  - name: sim-cards
    description: |
      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.


    x-displayName: SIM Cards

  - name: new-meter-readings
    description: |
      Operation on new meter readings

      ### New Meter Readings

      This enpoint is used by the different distributed AMR services that send
      data.
      It is not always knows by the external service what the database ID is
      for meter device or meter readings series. This endpoint will do lookups
      based on the names of the meter device and meter reading series.

    x-displayName: New Meter Readings

  - name: meter-security-keys
    description: |
      Operations on Meter Security Key Collection

      ### Meter Security Key Collection

      A Meter Security Key Collection holds all passwords, secrets and
      encryption keys for a meter device.

      The `dlms_master_key` will never be returned in any of the responses for security reasons.

      > Note: DLMS Keys are stored in hexadecimal strings. 128 bit key = 32 hex
      > characters, 256 bit key = 64 hex characters.

    x-displayName: Meter Security Key Collections

  - name: meter-readings
    description: |
      Operations on Meter Readings

      ### Meter Readings

      Meter Readings are the raw data we receive from meter devices.
      They are limited to numerical data.
      Meter Readings table is designed for short term storage of meter values.

    x-displayName: Meter Readings

  - name: meter-reading-series
    description: |
      Operations on Meter Reading Series

      ### Meter Reading Series

      A MeterReadingSeries is used for grouping all meter values that should be
      viewed as a time series of values. It also adds "metadata" about the series
      so that it is possible to know more about the values contained in it.

      In Utilitarian we aim to use OBIS codes as series identifier but there is
      nothing preventing the use of any identifier for a series. Simple string
      values like "energy" and "power" could be used or more complex identifiers
      like from the CIM standard.

      Since we might have electricity meters that have current and voltage
      transformers in their measurement loops we need to specify if the series
      is affected by either the current transformer and/or the voltage
      transformer ratio.

    x-displayName: Meter Reading Series

  - name: staged-meter-readings
    description: |
      Operations on Staged Meter Readings

      ### Staged Meter Readings

      Staged Meter Readings are meter readings that when they where received by
      Utilitarian API did not have a corresponding meter. This might be due to
      that the meter was set up in the field but was not yet set up in Utilitarian
      API. To avoid loosing values we save the meter readings for a while and
      whenever a new meter device is created we will save all staged meter
      readings as normal meter readings. We also clear the staging table of old
      values after a set amount of time to make sure the list doesn't grow to
      large.

    x-displayName: Staged Meter Readings

  - name: meter-system-events
    description: |
      Operations on Meter System Events

      ### Meter System Events

      A MeterSystemEvent is some form of event occurring in a MeterDevice. It
      could be an indication that something is wrong (Alarm) or an just a log
      entry that the meter switched to summer time.

    x-displayName: Meter System Events

  - name: network-interfaces
    description: |
      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.

    x-displayName: Network Interfaces

  - name: amr-task-groups
    description: |
      Operations on Amr Task Groups.

      ### Amr Task Groups

      Amr Task Groups are used for managing AMR Task that should be set on Meter
      Devices together.

      One good use is to have certain "AMR Profiles" as Amr Task Groups. For example if
      you have a group of meter that should be collected hourly and another daily you
      could set up two groups: 'Hourly' and 'Daily' then set the Amr Task Group on
      specified meter devices. If you then need to make adjustments in the daily jobs
      you can do this in one place, the Amr Task Group, and not on every individual
      meter device.

    x-displayName: Amr Task Groups

  - name: amr-tasks
    description: |
      Operations on Amr Tasks.

      ### Amr Tasks

      Amr Task are object containing information on how and when to run a AMR job.
      Amr Tasks are added to meter or Amr Task Groups. If added to a meter the task
      will run for that particular meter. If you need to manage a collection of tasks
      used for several meter, use an AmrTask Group.

    x-displayName: Amr Tasks

  - name: amr-tasks-invoke
    description: |
      Direct invocation of task on demand

      ### Invoke Amr Task

      It is possible to invoke the an AMR Task on demand by using this endpoint.
      It takes a meter device id and task info and will send the task directly to the
      async workerk.

    x-displayName: Invoke Amr Task

  - name: organizations-main
    description: |
      Operations on an Organization

      ### Organizations

      Organizationas are used to group entites to a single customer / organization.

    x-displayName: Organizations

  - name: organizations-memberships
    description: |
      Managing users membership in an organization.

      ### Organizations Membershitp

      Organizationas are used to group entites to a single customer / organization.

    x-displayName: Organizations Memebership



  # Common
  - name: Pagination
    x-traitTag: true
    description: |
      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.

      ``` json
      {
        "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.

  - name: Authentication
    x-traitTag: true
    description: |

      # 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`.




# Structuring the tags in the x-tagGroup also controls their order, so generated
# API specs doesn't scramble the order.
x-tagGroups:
  - name: Common
    tags:
      - Authentication
      - Pagination


  - name: Metering
    tags:
      - meter-devices
      - network-interfaces
      - sim-cards
      - meter-device-types
      - meter-device-configs
      - meter-reading-series
      - meter-readings
      - staged-meter-readings
      - new-meter-readings
      - meter-system-events
      - meter-security-keys
      - amr-task-groups
      - amr-tasks
      - amr-tasks-invoke

  - name: Organizations
    tags:
      - organizations-main
      - organizations-memberships

  - name: Auth
    tags:
      - auth




paths:
  /auth/jwt/change-organization/:
    post:
      operationId: auth_jwt_change-organization_create
      description: "Will issue a new token to an already \"logged in\" UserJwt User\
        \ for another\norganization"
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/TokenChangeOrg'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/TokenChangeOrg'
      tags:
        - auth
        - auth-jwt
        - auth-jwt-change-organization
        - jwt
        - change-organization
    parameters: []
  /auth/jwt/renew/:
    get:
      operationId: auth_jwt_renew_list
      description: Will issue a new JWT if the user has a valid JWT.
      parameters:
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
      tags:
        - auth
        - auth-jwt
        - auth-jwt-renew
        - jwt
        - renew
    parameters: []
  /auth/jwt/token/:
    post:
      operationId: auth_jwt_token_create
      description: "Providing username, password return token with access to first\n\
        available organization.\nIf an organization_id is provided return that organization\
        \ id if the user has\naccess to it.\n\n:param request:\n:param args:\n:param\
        \ kwargs:\n:return:"
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetTokenAuth'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/GetTokenAuth'
      tags:
        - auth
        - auth-jwt
        - auth-jwt-token
        - jwt
        - token
    parameters: []
  /metering/amr-task-groups/:
    get:
      operationId: metering_amr-task-groups_list
      description: Returns list of Amr Task Groups
      parameters:
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/AmrTaskGroup'
      tags:
        - metering
        - metering-amr-task-groups
        - amr-task-groups
    post:
      operationId: metering_amr-task-groups_create
      description: Create a new Amr Task Groups
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/AmrTaskGroup'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/AmrTaskGroup'
      tags:
        - metering
        - metering-amr-task-groups
        - amr-task-groups
    parameters: []
  /metering/amr-task-groups/{id}:
    get:
      operationId: metering_amr-task-groups_read
      description: Returns a single Amr Task Group
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/AmrTaskGroup'
      tags:
        - metering
        - metering-amr-task-groups
        - amr-task-groups
    put:
      operationId: metering_amr-task-groups_update
      description: Updates a single Amr Task Group
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/AmrTaskGroup'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/AmrTaskGroup'
      tags:
        - metering
        - metering-amr-task-groups
        - amr-task-groups
    patch:
      operationId: metering_amr-task-groups_partial_update
      description: Partially updates a single Amr Task Group
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/AmrTaskGroup'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/AmrTaskGroup'
      tags:
        - metering
        - metering-amr-task-groups
        - amr-task-groups
    delete:
      operationId: metering_amr-task-groups_delete
      description: Deletes a single Amr Task Group
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-amr-task-groups
        - amr-task-groups
    parameters:
      - name: id
        in: path
        description: A UUID string identifying this amr task group.
        required: true
        type: string
        format: uuid
  /metering/amr-tasks/:
    get:
      operationId: metering_amr-tasks_list
      description: Returns list of Amr Task
      parameters:
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/AmrTask'
      tags:
        - metering
        - metering-amr-tasks
        - amr-tasks
    post:
      operationId: metering_amr-tasks_create
      description: Create a new Amr Task
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/AmrTask'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/AmrTask'
      tags:
        - metering
        - metering-amr-tasks
        - amr-tasks
    parameters: []
  /metering/amr-tasks/invoke:
    post:
      operationId: metering_amr-tasks_invoke_create
      description: Invokes a task.
      parameters: []
      responses:
        '201':
          description: ''
      tags:
        - metering
        - metering-amr-tasks
        - metering-amr-tasks-invoke
        - amr-tasks
        - invoke
    parameters: []
  /metering/amr-tasks/{id}:
    get:
      operationId: metering_amr-tasks_read
      description: Returns a single Amr Task
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/AmrTask'
      tags:
        - metering
        - metering-amr-tasks
        - amr-tasks
    put:
      operationId: metering_amr-tasks_update
      description: Updates a single Amr Task
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/AmrTask'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/AmrTask'
      tags:
        - metering
        - metering-amr-tasks
        - amr-tasks
    patch:
      operationId: metering_amr-tasks_partial_update
      description: Partially updates a single Amr Task
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/AmrTask'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/AmrTask'
      tags:
        - metering
        - metering-amr-tasks
        - amr-tasks
    delete:
      operationId: metering_amr-tasks_delete
      description: Deletes a single Amr Task
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-amr-tasks
        - amr-tasks
    parameters:
      - name: id
        in: path
        description: A UUID string identifying this amr task.
        required: true
        type: string
        format: uuid
  /metering/meter-device-configs:
    get:
      operationId: metering_meter-device-configs_list
      description: Returns a list of MeterDeviceConfigs
      parameters:
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/MeterDeviceConfig'
      tags:
        - metering
        - metering-meter-device-configs
        - meter-device-configs
    post:
      operationId: metering_meter-device-configs_create
      description: Creates a MeterDeviceConfig
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterDeviceConfig'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/MeterDeviceConfig'
      tags:
        - metering
        - metering-meter-device-configs
        - meter-device-configs
    parameters: []
  /metering/meter-device-configs/{id}:
    get:
      operationId: metering_meter-device-configs_read
      description: Returns a single MeterDeviceConfig
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterDeviceConfig'
      tags:
        - metering
        - metering-meter-device-configs
        - meter-device-configs
    put:
      operationId: metering_meter-device-configs_update
      description: Updates a single MeterDeviceConfig
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterDeviceConfig'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterDeviceConfig'
      tags:
        - metering
        - metering-meter-device-configs
        - meter-device-configs
    patch:
      operationId: metering_meter-device-configs_partial_update
      description: Partially updates a single MeterDeviceConfig
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterDeviceConfig'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterDeviceConfig'
      tags:
        - metering
        - metering-meter-device-configs
        - meter-device-configs
    delete:
      operationId: metering_meter-device-configs_delete
      description: Deletes a single MeterDeviceConfig
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-meter-device-configs
        - meter-device-configs
    parameters:
      - name: id
        in: path
        description: A UUID string identifying this meter device config.
        required: true
        type: string
        format: uuid
  /metering/meter-device-types:
    get:
      operationId: metering_meter-device-types_list
      description: Returns a list of MeterDeviceTypess
      parameters:
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/MeterDeviceType'
      tags:
        - metering
        - metering-meter-device-types
        - meter-device-types
    post:
      operationId: metering_meter-device-types_create
      description: Creates a MeterDeviceType
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterDeviceType'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/MeterDeviceType'
      tags:
        - metering
        - metering-meter-device-types
        - meter-device-types
    parameters: []
  /metering/meter-device-types/{id}:
    get:
      operationId: metering_meter-device-types_read
      description: Returns a single MeterDeviceType
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterDeviceType'
      tags:
        - metering
        - metering-meter-device-types
        - meter-device-types
    put:
      operationId: metering_meter-device-types_update
      description: Updates a single MeterDeviceType
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterDeviceType'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterDeviceType'
      tags:
        - metering
        - metering-meter-device-types
        - meter-device-types
    patch:
      operationId: metering_meter-device-types_partial_update
      description: Partially updates a single MeterDeviceType
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterDeviceType'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterDeviceType'
      tags:
        - metering
        - metering-meter-device-types
        - meter-device-types
    delete:
      operationId: metering_meter-device-types_delete
      description: Deletes a single MeterDeviceType
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-meter-device-types
        - meter-device-types
    parameters:
      - name: id
        in: path
        description: A UUID string identifying this meter device type.
        required: true
        type: string
        format: uuid
  /metering/meter-devices:
    get:
      operationId: metering_meter-devices_list
      description: Returns a list of MeterDevices
      parameters:
        - name: name
          in: query
          description: ''
          required: false
          type: string
        - name: external_system_reference
          in: query
          description: ''
          required: false
          type: string
        - name: manufacturer_serial
          in: query
          description: ''
          required: false
          type: string
        - name: dlms_logical_device_name
          in: query
          description: ''
          required: false
          type: string
        - name: dlms_system_title
          in: query
          description: ''
          required: false
          type: string
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/MeterDevice'
      tags:
        - metering
        - metering-meter-devices
        - meter-devices
    post:
      operationId: metering_meter-devices_create
      description: Creates a MeterDevice
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterDevice'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/MeterDevice'
      tags:
        - metering
        - metering-meter-devices
        - meter-devices
    parameters: []
  /metering/meter-devices/{id}:
    get:
      operationId: metering_meter-devices_read
      description: Returns a single MeterDevice
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterDevice'
      tags:
        - metering
        - metering-meter-devices
        - meter-devices
    put:
      operationId: metering_meter-devices_update
      description: Updates a single MeterDevice
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterDevice'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterDevice'
      tags:
        - metering
        - metering-meter-devices
        - meter-devices
    patch:
      operationId: metering_meter-devices_partial_update
      description: Partially updates a single MeterDevice
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterDevice'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterDevice'
      tags:
        - metering
        - metering-meter-devices
        - meter-devices
    delete:
      operationId: metering_meter-devices_delete
      description: Deletes a single MeterDevice
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-meter-devices
        - meter-devices
    parameters:
      - name: id
        in: path
        description: A UUID string identifying this meter device.
        required: true
        type: string
        format: uuid
  /metering/meter-reading-series:
    get:
      operationId: metering_meter-reading-series_list
      description: Returns a list of MeterReadingSeries
      parameters:
        - name: name
          in: query
          description: ''
          required: false
          type: string
        - name: unit
          in: query
          description: ''
          required: false
          type: string
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/MeterReadingsSeries'
      tags:
        - metering
        - metering-meter-reading-series
        - meter-reading-series
    post:
      operationId: metering_meter-reading-series_create
      description: Create a MeterReadingSeries
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterReadingsSeries'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/MeterReadingsSeries'
      tags:
        - metering
        - metering-meter-reading-series
        - meter-reading-series
    parameters: []
  /metering/meter-reading-series/{id}:
    get:
      operationId: metering_meter-reading-series_read
      description: Returns a single MeterReadingSeries
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterReadingsSeries'
      tags:
        - metering
        - metering-meter-reading-series
        - meter-reading-series
    put:
      operationId: metering_meter-reading-series_update
      description: Updates a single MeterReadingSeries
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterReadingsSeries'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterReadingsSeries'
      tags:
        - metering
        - metering-meter-reading-series
        - meter-reading-series
    patch:
      operationId: metering_meter-reading-series_partial_update
      description: Partially updates a single MeterReadingSeries
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterReadingsSeries'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterReadingsSeries'
      tags:
        - metering
        - metering-meter-reading-series
        - meter-reading-series
    delete:
      operationId: metering_meter-reading-series_delete
      description: Deletes a single MeterReadingsSeries
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-meter-reading-series
        - meter-reading-series
    parameters:
      - name: id
        in: path
        description: A UUID string identifying this meter reading series.
        required: true
        type: string
        format: uuid
  /metering/meter-readings:
    get:
      operationId: metering_meter-readings_list
      description: "Returns a list of MeterReadings. Supply both meter_id and series_id\
        \ in\n    query parameters to get a complete series. Returns a list of only\n\
        \    values and timestamps. If the series and meter is omitted the values\n\
        \    will be mixed."
      parameters:
        - name: meter_device
          in: query
          description: ''
          required: false
          type: string
        - name: series
          in: query
          description: ''
          required: false
          type: string
        - name: start_time
          in: query
          description: ''
          required: false
          type: string
        - name: end_time
          in: query
          description: ''
          required: false
          type: string
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/MeterReadingsOut'
      tags:
        - metering
        - metering-meter-readings
        - meter-readings
    post:
      operationId: metering_meter-readings_create
      description: Creates a MeterReading
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterReadings'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/MeterReadings'
      tags:
        - metering
        - metering-meter-readings
        - meter-readings
    parameters: []
  /metering/meter-readings/{id}:
    get:
      operationId: metering_meter-readings_read
      description: Returns a single MeterReading
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterReadings'
      tags:
        - metering
        - metering-meter-readings
        - meter-readings
    delete:
      operationId: metering_meter-readings_delete
      description: Deletes a single MeterReading
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-meter-readings
        - meter-readings
    parameters:
      - name: id
        in: path
        description: A unique integer value identifying this meter reading.
        required: true
        type: integer
  /metering/meter-security-keys:
    get:
      operationId: metering_meter-security-keys_list
      description: Returns list of MeterSecurityCollections
      parameters:
        - name: meter
          in: query
          description: ''
          required: false
          type: string
        - name: meter_name
          in: query
          description: ''
          required: false
          type: string
        - name: meter_external_system_reference
          in: query
          description: ''
          required: false
          type: string
        - name: meter_manufacturer_serial
          in: query
          description: ''
          required: false
          type: string
        - name: meter_dlms_system_title
          in: query
          description: ''
          required: false
          type: string
        - name: meter_dlms_logical_device_name
          in: query
          description: ''
          required: false
          type: string
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/MeterSecurityKeyCollectionOut'
      tags:
        - metering
        - metering-meter-security-keys
        - meter-security-keys
    post:
      operationId: metering_meter-security-keys_create
      description: Creates a MeterSecurityKeyCollection
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterSecurityKeyCollectionIn'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/MeterSecurityKeyCollectionIn'
      tags:
        - metering
        - metering-meter-security-keys
        - meter-security-keys
    parameters: []
  /metering/meter-security-keys/{id}:
    get:
      operationId: metering_meter-security-keys_read
      description: Returns a single MeterSecurityKeyCollection
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterSecurityKeyCollectionOut'
      tags:
        - metering
        - metering-meter-security-keys
        - meter-security-keys
    delete:
      operationId: metering_meter-security-keys_delete
      description: Deletes a single MeterSecurityKeyCollection
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-meter-security-keys
        - meter-security-keys
    parameters:
      - name: id
        in: path
        description: A UUID string identifying this meter security key collection.
        required: true
        type: string
        format: uuid
  /metering/meter-system-events:
    get:
      operationId: metering_meter-system-events_list
      description: Returns a list of MeterSystemEvents
      parameters:
        - name: meter_device
          in: query
          description: ''
          required: false
          type: string
        - name: start_time
          in: query
          description: ''
          required: false
          type: string
        - name: end_time
          in: query
          description: ''
          required: false
          type: string
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/MeterSystemEvent'
      tags:
        - metering
        - metering-meter-system-events
        - meter-system-events
    post:
      operationId: metering_meter-system-events_create
      description: Creates a MeterSystemEvents
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/MeterSystemEvent'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/MeterSystemEvent'
      tags:
        - metering
        - metering-meter-system-events
        - meter-system-events
    parameters: []
  /metering/meter-system-events/{id}:
    get:
      operationId: metering_meter-system-events_read
      description: Returns a single MeterSystemEvent
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/MeterSystemEvent'
      tags:
        - metering
        - metering-meter-system-events
        - meter-system-events
    delete:
      operationId: metering_meter-system-events_delete
      description: Deletes a single MeterSystemEvent
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-meter-system-events
        - meter-system-events
    parameters:
      - name: id
        in: path
        description: A unique integer value identifying this meter system event.
        required: true
        type: integer
  /metering/network-interfaces:
    get:
      operationId: metering_network-interfaces_list
      description: returns list of NetworkInterfaces
      parameters:
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/NetworkInterface'
      tags:
        - metering
        - metering-network-interfaces
        - network-interfaces
    post:
      operationId: metering_network-interfaces_create
      description: Create a new Network Interface
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/NetworkInterface'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterface'
      tags:
        - metering
        - metering-network-interfaces
        - network-interfaces
    parameters: []
  /metering/network-interfaces/{id}:
    get:
      operationId: metering_network-interfaces_read
      description: Returns a single NetworkInterface
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterface'
      tags:
        - metering
        - metering-network-interfaces
        - network-interfaces
    put:
      operationId: metering_network-interfaces_update
      description: Updates a single Network Interface
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/NetworkInterface'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterface'
      tags:
        - metering
        - metering-network-interfaces
        - network-interfaces
    patch:
      operationId: metering_network-interfaces_partial_update
      description: Partially updates a single Network Interface
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/NetworkInterface'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/NetworkInterface'
      tags:
        - metering
        - metering-network-interfaces
        - network-interfaces
    delete:
      operationId: metering_network-interfaces_delete
      description: Deletes a single Network Interface
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-network-interfaces
        - network-interfaces
    parameters:
      - name: id
        in: path
        description: A UUID string identifying this network interface.
        required: true
        type: string
        format: uuid
  /metering/new-meter-readings:
    post:
      operationId: metering_new-meter-readings_create
      description: "Receives Meter Readings, single and in list and will send them\
        \ to background\n    workers for processing."
      parameters: []
      responses:
        '201':
          description: ''
      tags:
        - metering
        - metering-new-meter-readings
        - new-meter-readings
    parameters: []
  /metering/sim-cards:
    get:
      operationId: metering_sim-cards_list
      description: Returns a list of SimCards
      parameters:
        - name: iccid
          in: query
          description: ''
          required: false
          type: string
        - name: imsi
          in: query
          description: ''
          required: false
          type: string
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/SimCard'
      tags:
        - metering
        - metering-sim-cards
        - sim-cards
    post:
      operationId: metering_sim-cards_create
      description: Creates a new SimCard
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/SimCard'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/SimCard'
      tags:
        - metering
        - metering-sim-cards
        - sim-cards
    parameters: []
  /metering/sim-cards/{id}:
    get:
      operationId: metering_sim-cards_read
      description: Returns a single SimCard
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SimCard'
      tags:
        - metering
        - metering-sim-cards
        - sim-cards
    put:
      operationId: metering_sim-cards_update
      description: Updates a single SimCard
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/SimCard'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SimCard'
      tags:
        - metering
        - metering-sim-cards
        - sim-cards
    patch:
      operationId: metering_sim-cards_partial_update
      description: Partially updates a single SimCard
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/SimCard'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/SimCard'
      tags:
        - metering
        - metering-sim-cards
        - sim-cards
    delete:
      operationId: metering_sim-cards_delete
      description: Deletes a single SimCard
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-sim-cards
        - sim-cards
    parameters:
      - name: id
        in: path
        description: A UUID string identifying this sim card.
        required: true
        type: string
        format: uuid
  /metering/staged-meter-readings:
    get:
      operationId: metering_staged-meter-readings_list
      description: Returns list of Staged Meter Readings
      parameters:
        - name: meter_device_name
          in: query
          description: ''
          required: false
          type: string
        - name: start_time
          in: query
          description: ''
          required: false
          type: string
        - name: end_time
          in: query
          description: ''
          required: false
          type: string
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/StagedMeterReading'
      tags:
        - metering
        - metering-staged-meter-readings
        - staged-meter-readings
    post:
      operationId: metering_staged-meter-readings_create
      description: Create a new Staged Meter Readings
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/StagedMeterReading'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/StagedMeterReading'
      tags:
        - metering
        - metering-staged-meter-readings
        - staged-meter-readings
    parameters: []
  /metering/staged-meter-readings/{id}:
    get:
      operationId: metering_staged-meter-readings_read
      description: Returns a single Staged Meter Reading
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/StagedMeterReading'
      tags:
        - metering
        - metering-staged-meter-readings
        - staged-meter-readings
    put:
      operationId: metering_staged-meter-readings_update
      description: Updates a single Staged Meter Reading
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/StagedMeterReading'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/StagedMeterReading'
      tags:
        - metering
        - metering-staged-meter-readings
        - staged-meter-readings
    patch:
      operationId: metering_staged-meter-readings_partial_update
      description: Partially updates a single Staged Meter Reading
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/StagedMeterReading'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/StagedMeterReading'
      tags:
        - metering
        - metering-staged-meter-readings
        - staged-meter-readings
    delete:
      operationId: metering_staged-meter-readings_delete
      description: Deletes a single Staged Meter Reading
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - metering
        - metering-staged-meter-readings
        - staged-meter-readings
    parameters:
      - name: id
        in: path
        description: A unique integer value identifying this staged meter reading.
        required: true
        type: integer
  /organizations/:
    get:
      operationId: organizations_list
      description: returns list of Organizations
      parameters:
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/Organization'
      tags:
        - organizations
        - organizations-main
        - main
    post:
      operationId: organizations_create
      description: Create a new Organization
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/Organization'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/Organization'
      tags:
        - organizations
        - organizations-main
        - main
    parameters: []
  /organizations/memberships/:
    get:
      operationId: organizations_memberships_list
      description: returns list of Organization Memberships
      parameters:
        - name: limit
          in: query
          description: Number of results to return per page.
          required: false
          type: integer
        - name: offset
          in: query
          description: The initial index from which to return the results.
          required: false
          type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
              - count
              - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/OrganizationMember'
      tags:
        - organizations
        - organizations-memberships
        - memberships
    post:
      operationId: organizations_memberships_create
      description: Create a new Organization Membership
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/OrganizationMember'
      responses:
        '201':
          description: ''
          schema:
            $ref: '#/definitions/OrganizationMember'
      tags:
        - organizations
        - organizations-memberships
        - memberships
    parameters: []
  /organizations/memberships/{id}:
    get:
      operationId: organizations_memberships_read
      description: Returns a single Organization Membership
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/OrganizationMember'
      tags:
        - organizations
        - organizations-memberships
        - memberships
    put:
      operationId: organizations_memberships_update
      description: Updates a single Organization Membership
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/OrganizationMember'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/OrganizationMember'
      tags:
        - organizations
        - organizations-memberships
        - memberships
    patch:
      operationId: organizations_memberships_partial_update
      description: Partially updates a single Organization Membership
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/OrganizationMember'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/OrganizationMember'
      tags:
        - organizations
        - organizations-memberships
        - memberships
    delete:
      operationId: organizations_memberships_delete
      description: Deletes a single Organization Membership
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - organizations
        - organizations-memberships
        - memberships
    parameters:
      - name: id
        in: path
        description: A unique integer value identifying this organization member.
        required: true
        type: integer
  /organizations/{id}:
    get:
      operationId: organizations_read
      description: Returns a single Organization
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/Organization'
      tags:
        - organizations
        - organizations-main
        - main
    put:
      operationId: organizations_update
      description: Updates a single Organization
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/Organization'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/Organization'
      tags:
        - organizations
        - organizations-main
        - main
    patch:
      operationId: organizations_partial_update
      description: Partially updates a single Organization
      parameters:
        - name: data
          in: body
          required: true
          schema:
            $ref: '#/definitions/Organization'
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/Organization'
      tags:
        - organizations
        - organizations-main
        - main
    delete:
      operationId: organizations_delete
      description: Deletes a single Organization
      parameters: []
      responses:
        '204':
          description: ''
      tags:
        - organizations
        - organizations-main
        - main
    parameters:
      - name: id
        in: path
        description: A UUID string identifying this organization.
        required: true
        type: string
        format: uuid
definitions:
  TokenChangeOrg:
    required:
      - organization
    type: object
    properties:
      organization:
        type: string
        format: uuid
        title: Organization
  GetTokenAuth:
    required:
      - username
      - password
    type: object
    properties:
      username:
        title: Username
        type: string
        minLength: 1
      password:
        title: Password
        type: string
        minLength: 1
      organization:
        title: Organization
        type: string
        format: uuid
        x-nullable: true
  AmrTaskGroup:
    required:
      - name
      - organization
    type: object
    properties:
      id:
        title: Primary Key
        type: string
        format: uuid
        readOnly: true
      name:
        title: Name
        type: string
        maxLength: 150
        minLength: 1
      organization:
        title: Organization
        type: string
        format: uuid
      description:
        title: Description
        type: string
        maxLength: 500
      tasks:
        description: Choose AMR Tasks that should be a part of this group.
        type: array
        items:
          title: AMR Tasks
          description: Choose AMR Tasks that should be a part of this group.
          type: string
          format: uuid
        uniqueItems: true
      tasks_info:
        title: Tasks info
        type: string
        readOnly: true
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  AmrTask:
    required:
      - organization
      - name
      - schedule
      - meter_execution_type
      - task_call
    type: object
    properties:
      id:
        title: Primary Key
        type: string
        format: uuid
        readOnly: true
      organization:
        title: Organization
        type: string
        format: uuid
      name:
        title: Name
        type: string
        maxLength: 150
        minLength: 1
      description:
        title: Description
        type: string
        maxLength: 500
      is_active:
        title: Is active
        type: boolean
      schedule:
        title: AMR Schedule
        description: How often to run the task
        type: string
        enum:
          - quarterly
          - hourly
          - daily
          - weekly
          - monthly
          - yearly
      run_offset_seconds:
        title: Run offset
        description: Value in seconds
        type: integer
        maximum: 2147483647
        minimum: -2147483648
      meter_execution_type:
        title: Meter execution type
        description: The execution interface for this task
        type: string
        enum:
          - generic_lis200
          - generic_iec6205621
          - generic_corus_meter
      task_call:
        title: Task function call
        description: The function to call on the execution interface
        type: string
        maxLength: 50
        minLength: 1
      task_kwargs:
        title: Keyword arguments
        description: Keyword arguments for task. In JSON
        type: object
        x-nullable: true
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  MeterDeviceConfig:
    required:
      - organization
      - name
      - series
    type: object
    properties:
      id:
        title: Primary Key
        type: string
        format: uuid
        readOnly: true
      organization:
        title: Organization
        type: string
        format: uuid
      name:
        title: Device config name
        type: string
        maxLength: 50
        minLength: 1
      series:
        description: Choose meter readings series that will be allowed for this meter
          device config.
        type: array
        items:
          title: Meter Reading Series
          description: Choose meter readings series that will be allowed for this
            meter device config.
          type: string
          format: uuid
        uniqueItems: true
      series_info:
        title: Series info
        type: string
        readOnly: true
      timezone:
        title: Meter timezone
        description: Name of timezone the meter operates in. For fixed offset constructed
          zones (ex. 'Etc/GMT-1') take notise that we are following standard conventions
          and the sign is inverted. See more at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
        type: string
        enum:
          - Africa/Abidjan
          - Africa/Accra
          - Africa/Addis_Ababa
          - Africa/Algiers
          - Africa/Asmara
          - Africa/Asmera
          - Africa/Bamako
          - Africa/Bangui
          - Africa/Banjul
          - Africa/Bissau
          - Africa/Blantyre
          - Africa/Brazzaville
          - Africa/Bujumbura
          - Africa/Cairo
          - Africa/Casablanca
          - Africa/Ceuta
          - Africa/Conakry
          - Africa/Dakar
          - Africa/Dar_es_Salaam
          - Africa/Djibouti
          - Africa/Douala
          - Africa/El_Aaiun
          - Africa/Freetown
          - Africa/Gaborone
          - Africa/Harare
          - Africa/Johannesburg
          - Africa/Juba
          - Africa/Kampala
          - Africa/Khartoum
          - Africa/Kigali
          - Africa/Kinshasa
          - Africa/Lagos
          - Africa/Libreville
          - Africa/Lome
          - Africa/Luanda
          - Africa/Lubumbashi
          - Africa/Lusaka
          - Africa/Malabo
          - Africa/Maputo
          - Africa/Maseru
          - Africa/Mbabane
          - Africa/Mogadishu
          - Africa/Monrovia
          - Africa/Nairobi
          - Africa/Ndjamena
          - Africa/Niamey
          - Africa/Nouakchott
          - Africa/Ouagadougou
          - Africa/Porto-Novo
          - Africa/Sao_Tome
          - Africa/Timbuktu
          - Africa/Tripoli
          - Africa/Tunis
          - Africa/Windhoek
          - America/Adak
          - America/Anchorage
          - America/Anguilla
          - America/Antigua
          - America/Araguaina
          - America/Argentina/Buenos_Aires
          - America/Argentina/Catamarca
          - America/Argentina/ComodRivadavia
          - America/Argentina/Cordoba
          - America/Argentina/Jujuy
          - America/Argentina/La_Rioja
          - America/Argentina/Mendoza
          - America/Argentina/Rio_Gallegos
          - America/Argentina/Salta
          - America/Argentina/San_Juan
          - America/Argentina/San_Luis
          - America/Argentina/Tucuman
          - America/Argentina/Ushuaia
          - America/Aruba
          - America/Asuncion
          - America/Atikokan
          - America/Atka
          - America/Bahia
          - America/Bahia_Banderas
          - America/Barbados
          - America/Belem
          - America/Belize
          - America/Blanc-Sablon
          - America/Boa_Vista
          - America/Bogota
          - America/Boise
          - America/Buenos_Aires
          - America/Cambridge_Bay
          - America/Campo_Grande
          - America/Cancun
          - America/Caracas
          - America/Catamarca
          - America/Cayenne
          - America/Cayman
          - America/Chicago
          - America/Chihuahua
          - America/Coral_Harbour
          - America/Cordoba
          - America/Costa_Rica
          - America/Creston
          - America/Cuiaba
          - America/Curacao
          - America/Danmarkshavn
          - America/Dawson
          - America/Dawson_Creek
          - America/Denver
          - America/Detroit
          - America/Dominica
          - America/Edmonton
          - America/Eirunepe
          - America/El_Salvador
          - America/Ensenada
          - America/Fort_Nelson
          - America/Fort_Wayne
          - America/Fortaleza
          - America/Glace_Bay
          - America/Godthab
          - America/Goose_Bay
          - America/Grand_Turk
          - America/Grenada
          - America/Guadeloupe
          - America/Guatemala
          - America/Guayaquil
          - America/Guyana
          - America/Halifax
          - America/Havana
          - America/Hermosillo
          - America/Indiana/Indianapolis
          - America/Indiana/Knox
          - America/Indiana/Marengo
          - America/Indiana/Petersburg
          - America/Indiana/Tell_City
          - America/Indiana/Vevay
          - America/Indiana/Vincennes
          - America/Indiana/Winamac
          - America/Indianapolis
          - America/Inuvik
          - America/Iqaluit
          - America/Jamaica
          - America/Jujuy
          - America/Juneau
          - America/Kentucky/Louisville
          - America/Kentucky/Monticello
          - America/Knox_IN
          - America/Kralendijk
          - America/La_Paz
          - America/Lima
          - America/Los_Angeles
          - America/Louisville
          - America/Lower_Princes
          - America/Maceio
          - America/Managua
          - America/Manaus
          - America/Marigot
          - America/Martinique
          - America/Matamoros
          - America/Mazatlan
          - America/Mendoza
          - America/Menominee
          - America/Merida
          - America/Metlakatla
          - America/Mexico_City
          - America/Miquelon
          - America/Moncton
          - America/Monterrey
          - America/Montevideo
          - America/Montreal
          - America/Montserrat
          - America/Nassau
          - America/New_York
          - America/Nipigon
          - America/Nome
          - America/Noronha
          - America/North_Dakota/Beulah
          - America/North_Dakota/Center
          - America/North_Dakota/New_Salem
          - America/Ojinaga
          - America/Panama
          - America/Pangnirtung
          - America/Paramaribo
          - America/Phoenix
          - America/Port-au-Prince
          - America/Port_of_Spain
          - America/Porto_Acre
          - America/Porto_Velho
          - America/Puerto_Rico
          - America/Punta_Arenas
          - America/Rainy_River
          - America/Rankin_Inlet
          - America/Recife
          - America/Regina
          - America/Resolute
          - America/Rio_Branco
          - America/Rosario
          - America/Santa_Isabel
          - America/Santarem
          - America/Santiago
          - America/Santo_Domingo
          - America/Sao_Paulo
          - America/Scoresbysund
          - America/Shiprock
          - America/Sitka
          - America/St_Barthelemy
          - America/St_Johns
          - America/St_Kitts
          - America/St_Lucia
          - America/St_Thomas
          - America/St_Vincent
          - America/Swift_Current
          - America/Tegucigalpa
          - America/Thule
          - America/Thunder_Bay
          - America/Tijuana
          - America/Toronto
          - America/Tortola
          - America/Vancouver
          - America/Virgin
          - America/Whitehorse
          - America/Winnipeg
          - America/Yakutat
          - America/Yellowknife
          - Antarctica/Casey
          - Antarctica/Davis
          - Antarctica/DumontDUrville
          - Antarctica/Macquarie
          - Antarctica/Mawson
          - Antarctica/McMurdo
          - Antarctica/Palmer
          - Antarctica/Rothera
          - Antarctica/South_Pole
          - Antarctica/Syowa
          - Antarctica/Troll
          - Antarctica/Vostok
          - Arctic/Longyearbyen
          - Asia/Aden
          - Asia/Almaty
          - Asia/Amman
          - Asia/Anadyr
          - Asia/Aqtau
          - Asia/Aqtobe
          - Asia/Ashgabat
          - Asia/Ashkhabad
          - Asia/Atyrau
          - Asia/Baghdad
          - Asia/Bahrain
          - Asia/Baku
          - Asia/Bangkok
          - Asia/Barnaul
          - Asia/Beirut
          - Asia/Bishkek
          - Asia/Brunei
          - Asia/Calcutta
          - Asia/Chita
          - Asia/Choibalsan
          - Asia/Chongqing
          - Asia/Chungking
          - Asia/Colombo
          - Asia/Dacca
          - Asia/Damascus
          - Asia/Dhaka
          - Asia/Dili
          - Asia/Dubai
          - Asia/Dushanbe
          - Asia/Famagusta
          - Asia/Gaza
          - Asia/Hanoi
          - Asia/Harbin
          - Asia/Hebron
          - Asia/Ho_Chi_Minh
          - Asia/Hong_Kong
          - Asia/Hovd
          - Asia/Irkutsk
          - Asia/Istanbul
          - Asia/Jakarta
          - Asia/Jayapura
          - Asia/Jerusalem
          - Asia/Kabul
          - Asia/Kamchatka
          - Asia/Karachi
          - Asia/Kashgar
          - Asia/Kathmandu
          - Asia/Katmandu
          - Asia/Khandyga
          - Asia/Kolkata
          - Asia/Krasnoyarsk
          - Asia/Kuala_Lumpur
          - Asia/Kuching
          - Asia/Kuwait
          - Asia/Macao
          - Asia/Macau
          - Asia/Magadan
          - Asia/Makassar
          - Asia/Manila
          - Asia/Muscat
          - Asia/Nicosia
          - Asia/Novokuznetsk
          - Asia/Novosibirsk
          - Asia/Omsk
          - Asia/Oral
          - Asia/Phnom_Penh
          - Asia/Pontianak
          - Asia/Pyongyang
          - Asia/Qatar
          - Asia/Qostanay
          - Asia/Qyzylorda
          - Asia/Rangoon
          - Asia/Riyadh
          - Asia/Saigon
          - Asia/Sakhalin
          - Asia/Samarkand
          - Asia/Seoul
          - Asia/Shanghai
          - Asia/Singapore
          - Asia/Srednekolymsk
          - Asia/Taipei
          - Asia/Tashkent
          - Asia/Tbilisi
          - Asia/Tehran
          - Asia/Tel_Aviv
          - Asia/Thimbu
          - Asia/Thimphu
          - Asia/Tokyo
          - Asia/Tomsk
          - Asia/Ujung_Pandang
          - Asia/Ulaanbaatar
          - Asia/Ulan_Bator
          - Asia/Urumqi
          - Asia/Ust-Nera
          - Asia/Vientiane
          - Asia/Vladivostok
          - Asia/Yakutsk
          - Asia/Yangon
          - Asia/Yekaterinburg
          - Asia/Yerevan
          - Atlantic/Azores
          - Atlantic/Bermuda
          - Atlantic/Canary
          - Atlantic/Cape_Verde
          - Atlantic/Faeroe
          - Atlantic/Faroe
          - Atlantic/Jan_Mayen
          - Atlantic/Madeira
          - Atlantic/Reykjavik
          - Atlantic/South_Georgia
          - Atlantic/St_Helena
          - Atlantic/Stanley
          - Australia/ACT
          - Australia/Adelaide
          - Australia/Brisbane
          - Australia/Broken_Hill
          - Australia/Canberra
          - Australia/Currie
          - Australia/Darwin
          - Australia/Eucla
          - Australia/Hobart
          - Australia/LHI
          - Australia/Lindeman
          - Australia/Lord_Howe
          - Australia/Melbourne
          - Australia/NSW
          - Australia/North
          - Australia/Perth
          - Australia/Queensland
          - Australia/South
          - Australia/Sydney
          - Australia/Tasmania
          - Australia/Victoria
          - Australia/West
          - Australia/Yancowinna
          - Brazil/Acre
          - Brazil/DeNoronha
          - Brazil/East
          - Brazil/West
          - CET
          - CST6CDT
          - Canada/Atlantic
          - Canada/Central
          - Canada/Eastern
          - Canada/Mountain
          - Canada/Newfoundland
          - Canada/Pacific
          - Canada/Saskatchewan
          - Canada/Yukon
          - Chile/Continental
          - Chile/EasterIsland
          - Cuba
          - EET
          - EST
          - EST5EDT
          - Egypt
          - Eire
          - Etc/GMT
          - Etc/GMT+0
          - Etc/GMT+1
          - Etc/GMT+10
          - Etc/GMT+11
          - Etc/GMT+12
          - Etc/GMT+2
          - Etc/GMT+3
          - Etc/GMT+4
          - Etc/GMT+5
          - Etc/GMT+6
          - Etc/GMT+7
          - Etc/GMT+8
          - Etc/GMT+9
          - Etc/GMT-0
          - Etc/GMT-1
          - Etc/GMT-10
          - Etc/GMT-11
          - Etc/GMT-12
          - Etc/GMT-13
          - Etc/GMT-14
          - Etc/GMT-2
          - Etc/GMT-3
          - Etc/GMT-4
          - Etc/GMT-5
          - Etc/GMT-6
          - Etc/GMT-7
          - Etc/GMT-8
          - Etc/GMT-9
          - Etc/GMT0
          - Etc/Greenwich
          - Etc/UCT
          - Etc/UTC
          - Etc/Universal
          - Etc/Zulu
          - Europe/Amsterdam
          - Europe/Andorra
          - Europe/Astrakhan
          - Europe/Athens
          - Europe/Belfast
          - Europe/Belgrade
          - Europe/Berlin
          - Europe/Bratislava
          - Europe/Brussels
          - Europe/Bucharest
          - Europe/Budapest
          - Europe/Busingen
          - Europe/Chisinau
          - Europe/Copenhagen
          - Europe/Dublin
          - Europe/Gibraltar
          - Europe/Guernsey
          - Europe/Helsinki
          - Europe/Isle_of_Man
          - Europe/Istanbul
          - Europe/Jersey
          - Europe/Kaliningrad
          - Europe/Kiev
          - Europe/Kirov
          - Europe/Lisbon
          - Europe/Ljubljana
          - Europe/London
          - Europe/Luxembourg
          - Europe/Madrid
          - Europe/Malta
          - Europe/Mariehamn
          - Europe/Minsk
          - Europe/Monaco
          - Europe/Moscow
          - Europe/Nicosia
          - Europe/Oslo
          - Europe/Paris
          - Europe/Podgorica
          - Europe/Prague
          - Europe/Riga
          - Europe/Rome
          - Europe/Samara
          - Europe/San_Marino
          - Europe/Sarajevo
          - Europe/Saratov
          - Europe/Simferopol
          - Europe/Skopje
          - Europe/Sofia
          - Europe/Stockholm
          - Europe/Tallinn
          - Europe/Tirane
          - Europe/Tiraspol
          - Europe/Ulyanovsk
          - Europe/Uzhgorod
          - Europe/Vaduz
          - Europe/Vatican
          - Europe/Vienna
          - Europe/Vilnius
          - Europe/Volgograd
          - Europe/Warsaw
          - Europe/Zagreb
          - Europe/Zaporozhye
          - Europe/Zurich
          - Factory
          - GB
          - GB-Eire
          - GMT
          - GMT+0
          - GMT-0
          - GMT0
          - Greenwich
          - HST
          - Hongkong
          - Iceland
          - Indian/Antananarivo
          - Indian/Chagos
          - Indian/Christmas
          - Indian/Cocos
          - Indian/Comoro
          - Indian/Kerguelen
          - Indian/Mahe
          - Indian/Maldives
          - Indian/Mauritius
          - Indian/Mayotte
          - Indian/Reunion
          - Iran
          - Israel
          - Jamaica
          - Japan
          - Kwajalein
          - Libya
          - MET
          - MST
          - MST7MDT
          - Mexico/BajaNorte
          - Mexico/BajaSur
          - Mexico/General
          - NZ
          - NZ-CHAT
          - Navajo
          - PRC
          - PST8PDT
          - Pacific/Apia
          - Pacific/Auckland
          - Pacific/Bougainville
          - Pacific/Chatham
          - Pacific/Chuuk
          - Pacific/Easter
          - Pacific/Efate
          - Pacific/Enderbury
          - Pacific/Fakaofo
          - Pacific/Fiji
          - Pacific/Funafuti
          - Pacific/Galapagos
          - Pacific/Gambier
          - Pacific/Guadalcanal
          - Pacific/Guam
          - Pacific/Honolulu
          - Pacific/Johnston
          - Pacific/Kiritimati
          - Pacific/Kosrae
          - Pacific/Kwajalein
          - Pacific/Majuro
          - Pacific/Marquesas
          - Pacific/Midway
          - Pacific/Nauru
          - Pacific/Niue
          - Pacific/Norfolk
          - Pacific/Noumea
          - Pacific/Pago_Pago
          - Pacific/Palau
          - Pacific/Pitcairn
          - Pacific/Pohnpei
          - Pacific/Ponape
          - Pacific/Port_Moresby
          - Pacific/Rarotonga
          - Pacific/Saipan
          - Pacific/Samoa
          - Pacific/Tahiti
          - Pacific/Tarawa
          - Pacific/Tongatapu
          - Pacific/Truk
          - Pacific/Wake
          - Pacific/Wallis
          - Pacific/Yap
          - Poland
          - Portugal
          - ROC
          - ROK
          - Singapore
          - Turkey
          - UCT
          - US/Alaska
          - US/Aleutian
          - US/Arizona
          - US/Central
          - US/East-Indiana
          - US/Eastern
          - US/Hawaii
          - US/Indiana-Starke
          - US/Michigan
          - US/Mountain
          - US/Pacific
          - US/Pacific-New
          - US/Samoa
          - UTC
          - Universal
          - W-SU
          - WET
          - Zulu
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  MeterDeviceType:
    required:
      - organization
      - name
      - manufacturer
      - manufacturer_model
    type: object
    properties:
      id:
        title: Primary Key
        type: string
        format: uuid
        readOnly: true
      organization:
        title: Organization
        type: string
        format: uuid
      name:
        title: Name
        type: string
        maxLength: 50
        minLength: 1
      description:
        title: Description
        type: string
        maxLength: 500
      manufacturer:
        title: Manufacturer name
        type: string
        maxLength: 100
        minLength: 1
      manufacturer_model:
        title: Manufacturer model name
        type: string
        maxLength: 50
        minLength: 1
      config:
        title: Config
        type: string
        format: uuid
        x-nullable: true
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  MeterDevice:
    required:
      - name
      - protocol
    type: object
    properties:
      id:
        title: Primary Key
        type: string
        format: uuid
        readOnly: true
      organization:
        title: Organization
        type: string
        format: uuid
        x-nullable: true
      name:
        title: Unique name or identification
        type: string
        maxLength: 50
        minLength: 1
      external_system_reference:
        title: External system reference
        type: string
        maxLength: 50
        x-nullable: true
      manufacturer_serial:
        title: Serial number from manufacturer
        type: string
        maxLength: 50
        x-nullable: true
      protocol:
        title: Communication protocol
        type: string
        enum:
          - dlms-cosem
          - iec62056-21
          - i-flag
          - mbus
          - modbus
          - lis-200
      iec62056_21_address:
        title: IEC62056-21 meter address
        description: Only used for IEC62056-21 communication
        type: string
        maxLength: 8
        x-nullable: true
      dlms_logical_device_name:
        title: DLMS Logical Device Name
        description: Only used for DLMS communication
        type: string
        pattern: ^[abcdefABCDEF1234567890]*$
        maxLength: 32
        x-nullable: true
      dlms_system_title:
        title: DLMS System Title
        description: Only used for DLMS communication
        type: string
        pattern: ^[abcdefABCDEF1234567890]*$
        maxLength: 16
        x-nullable: true
      type:
        title: Type
        type: string
        format: uuid
        x-nullable: true
      task_groups:
        description: Choose AMR Task Groups the meter device should be a part of.
        type: array
        items:
          title: AMR Task Groups
          description: Choose AMR Task Groups the meter device should be a part of.
          type: string
          format: uuid
        uniqueItems: true
      meter_tasks:
        description: Choose AMR Tasks that are just for this meter device.
        type: array
        items:
          title: AMR Tasks
          description: Choose AMR Tasks that are just for this meter device.
          type: string
          format: uuid
        uniqueItems: true
      network_interface:
        title: Network interface
        type: string
        format: uuid
        x-nullable: true
      network_interface_info:
        title: Network interface info
        type: string
        readOnly: true
      has_current_transformer:
        title: Has current transformer
        description: Indicates if the meter has a current transformer in its measurement
          loop.
        type: boolean
      current_transformer_ratio:
        title: Current transformer ratio
        description: 'The ratio of the current transformer, Ex: 150/5 = 30'
        type: integer
        maximum: 2147483647
        minimum: -2147483648
      has_voltage_transformer:
        title: Has voltage transformer
        description: Indicates if the meter has a voltage transformer in its measurement
          loop.
        type: boolean
      voltage_transformer_ratio:
        title: Voltage transformer ratio
        description: 'The ratio of the voltage transformer, Ex: 150/5 = 30'
        type: integer
        maximum: 2147483647
        minimum: -2147483648
      has_disconnector:
        title: Has disconnector
        description: indicates if the meter device has a disconnector
        type: boolean
      disconnector_status:
        title: Disconnector status
        type: integer
        enum:
          - 0
          - 1
          - 2
        x-nullable: true
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  MeterReadingsSeries:
    required:
      - organization
      - name
      - unit
    type: object
    properties:
      id:
        title: Primary Key
        type: string
        format: uuid
        readOnly: true
      organization:
        title: Organization
        type: string
        format: uuid
      name:
        title: Name
        description: Used to group meter readings.
        type: string
        maxLength: 50
        minLength: 1
      description:
        title: Description
        type: string
        maxLength: 250
      unit:
        title: Unit
        description: 'Unit characters of the series, ex: kWh'
        type: string
        maxLength: 10
        minLength: 1
      unit_description:
        title: Unit description
        description: Longer name of unit or more info about the unit, Ex Celsius or
          Bar, Atmospheric.
        type: string
        maxLength: 250
        minLength: 1
        x-nullable: true
      si_multiplier:
        title: SI Multiplier
        description: Multiplier to get series unit in SI unit. Ex  1 kPa = 1000 *
          1 Pa.
        type: string
        format: decimal
      affected_by_ct_ratio:
        title: Affected by current transformer ratio
        description: Indicates if series is affected by the current transformer of
          the meter. Is used for calculations.
        type: boolean
      affected_by_vt_ratio:
        title: Affected by voltage transformer ratio
        description: Indicates if series is affected by the voltage transformer of
          the meter. Is used in calculations.
        type: boolean
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  MeterReadingsOut:
    required:
      - timestamp
      - value
    type: object
    properties:
      timestamp:
        title: Timestamp
        description: Time when the reading was registered in the meter.
        type: string
        format: date-time
      value:
        title: Value
        type: string
        format: decimal
  MeterReadings:
    required:
      - organization
      - meter_device
      - series
      - timestamp
      - value
    type: object
    properties:
      id:
        title: Id
        type: integer
        readOnly: true
      organization:
        title: Organization
        type: string
        format: uuid
      meter_device:
        title: Meter device
        type: string
        format: uuid
      series:
        title: Series
        type: string
        format: uuid
      timestamp:
        title: Timestamp
        description: Time when the reading was registered in the meter.
        type: string
        format: date-time
      value:
        title: Value
        type: string
        format: decimal
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
  MeterSecurityKeyCollectionOut:
    type: object
    properties:
      id:
        title: Primary Key
        type: string
        format: uuid
        readOnly: true
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
      iec62056_21_password:
        title: IEC62056-21 Password
        description: Used in IEC 62056-21 communication
        type: string
        maxLength: 8
        minLength: 1
        x-nullable: true
      dlms_global_unicast_encryption_key:
        title: Global Unicast Encryption Key, GUEK
        description: Used in DLMS communication
        type: string
        pattern: ^[abcdefABCDEF1234567890]*$
        maxLength: 64
        x-nullable: true
      dlms_global_broadcast_encryption_key:
        title: Global Broadcast Encryption Key, GBEK
        description: Used in DLMS communication
        type: string
        pattern: ^[abcdefABCDEF1234567890]*$
        maxLength: 64
        x-nullable: true
      dlms_global_authentication_key:
        title: Global Authentication Key, GAK
        description: Used in DLMS communication
        type: string
        pattern: ^[abcdefABCDEF1234567890]*$
        maxLength: 64
        x-nullable: true
      meter:
        required:
          - name
          - protocol
        type: object
        properties:
          id:
            title: Primary Key
            type: string
            format: uuid
            readOnly: true
          created_at:
            title: Created at
            type: string
            format: date-time
            readOnly: true
          updated_at:
            title: Updated at
            type: string
            format: date-time
            readOnly: true
          name:
            title: Unique name or identification
            type: string
            maxLength: 50
            minLength: 1
          external_system_reference:
            title: External system reference
            type: string
            maxLength: 50
            x-nullable: true
          manufacturer_serial:
            title: Serial number from manufacturer
            type: string
            maxLength: 50
            x-nullable: true
          protocol:
            title: Communication protocol
            type: string
            enum:
              - dlms-cosem
              - iec62056-21
              - i-flag
              - mbus
              - modbus
              - lis-200
          iec62056_21_address:
            title: IEC62056-21 meter address
            description: Only used for IEC62056-21 communication
            type: string
            maxLength: 8
            x-nullable: true
          dlms_logical_device_name:
            title: DLMS Logical Device Name
            description: Only used for DLMS communication
            type: string
            pattern: ^[abcdefABCDEF1234567890]*$
            maxLength: 32
            x-nullable: true
          dlms_system_title:
            title: DLMS System Title
            description: Only used for DLMS communication
            type: string
            pattern: ^[abcdefABCDEF1234567890]*$
            maxLength: 16
            x-nullable: true
          has_current_transformer:
            title: Has current transformer
            description: Indicates if the meter has a current transformer in its measurement
              loop.
            type: boolean
          current_transformer_ratio:
            title: Current transformer ratio
            description: 'The ratio of the current transformer, Ex: 150/5 = 30'
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          has_voltage_transformer:
            title: Has voltage transformer
            description: Indicates if the meter has a voltage transformer in its measurement
              loop.
            type: boolean
          voltage_transformer_ratio:
            title: Voltage transformer ratio
            description: 'The ratio of the voltage transformer, Ex: 150/5 = 30'
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          has_disconnector:
            title: Has disconnector
            description: indicates if the meter device has a disconnector
            type: boolean
          disconnector_status:
            title: Disconnector status
            type: integer
            enum:
              - 0
              - 1
              - 2
            x-nullable: true
          organization:
            title: Organization
            type: string
            format: uuid
            x-nullable: true
          type:
            title: Type
            type: string
            format: uuid
            x-nullable: true
          network_interface:
            title: Network interface
            type: string
            format: uuid
            x-nullable: true
          task_groups:
            description: Choose AMR Task Groups the meter device should be a part
              of.
            type: array
            items:
              title: AMR Task Groups
              description: Choose AMR Task Groups the meter device should be a part
                of.
              type: string
              format: uuid
            uniqueItems: true
          meter_tasks:
            description: Choose AMR Tasks that are just for this meter device.
            type: array
            items:
              title: AMR Tasks
              description: Choose AMR Tasks that are just for this meter device.
              type: string
              format: uuid
            uniqueItems: true
        readOnly: true
  MeterSecurityKeyCollectionIn:
    required:
      - meter
    type: object
    properties:
      id:
        title: Primary Key
        type: string
        format: uuid
        readOnly: true
      meter:
        title: Meter
        type: string
        format: uuid
      iec62056_21_password:
        title: IEC62056-21 Password
        description: Used in IEC 62056-21 communication
        type: string
        maxLength: 8
        minLength: 1
        x-nullable: true
      dlms_global_unicast_encryption_key:
        title: Global Unicast Encryption Key, GUEK
        description: Used in DLMS communication
        type: string
        pattern: ^[abcdefABCDEF1234567890]*$
        maxLength: 64
        x-nullable: true
      dlms_global_broadcast_encryption_key:
        title: Global Broadcast Encryption Key, GBEK
        description: Used in DLMS communication
        type: string
        pattern: ^[abcdefABCDEF1234567890]*$
        maxLength: 64
        x-nullable: true
      dlms_master_key:
        title: Master Key or Key Encrypting Key, KEK
        description: Used in DLMS communication
        type: string
        pattern: ^[abcdefABCDEF1234567890]*$
        maxLength: 64
        x-nullable: true
      dlms_global_authentication_key:
        title: Global Authentication Key, GAK
        description: Used in DLMS communication
        type: string
        pattern: ^[abcdefABCDEF1234567890]*$
        maxLength: 64
        x-nullable: true
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  MeterSystemEvent:
    required:
      - organization
      - meter_device
      - timestamp
      - title
      - content
    type: object
    properties:
      id:
        title: Id
        type: integer
        readOnly: true
      organization:
        title: Organization
        type: string
        format: uuid
      meter_device:
        title: Meter device
        type: string
        format: uuid
      timestamp:
        title: Timestamp
        description: Time when the event was registered in the meter device
        type: string
        format: date-time
      title:
        title: Event title
        type: string
        maxLength: 50
        minLength: 1
      content:
        title: Event content
        description: Additional information about the meter system event.
        type: string
        maxLength: 500
        minLength: 1
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  NetworkInterface:
    required:
      - organization
    type: object
    properties:
      id:
        title: Primary Key
        type: string
        format: uuid
        readOnly: true
      organization:
        title: Organization
        type: string
        format: uuid
      static_ip_address:
        title: Static IP address
        description: 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.
        type: string
        minLength: 1
        x-nullable: true
      host:
        title: Host
        type: string
        readOnly: true
      fqdn:
        title: FQDN
        description: 'Will override any set IP and use DNS to lookup IP of meters.
          Ex: meter098765.mydomain.com .'
        type: string
        maxLength: 200
        x-nullable: true
      port:
        title: Port
        description: Port used for IP communication.
        type: integer
        maximum: 2147483647
        minimum: 0
        x-nullable: true
      sim:
        title: Sim
        type: string
        format: uuid
        x-nullable: true
      can_block:
        title: Can block
        description: It is possible to block the network interface.
        type: boolean
      is_blocked:
        title: Is blocked
        description: Indicates if the network interface is currently blocked
        type: boolean
        readOnly: true
      block_time:
        title: Block time
        description: Time when block was initiated
        type: string
        format: date-time
        readOnly: true
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  SimCard:
    required:
      - iccid
      - imsi
    type: object
    properties:
      id:
        title: Primary Key
        type: string
        format: uuid
        readOnly: true
      organization:
        title: Organization
        type: string
        format: uuid
        x-nullable: true
      iccid:
        title: ICCID
        type: string
        pattern: ^[0123456789]*$
        maxLength: 20
        minLength: 1
      imsi:
        title: IMSI
        type: string
        pattern: ^[0123456789]*$
        maxLength: 15
        minLength: 1
      ip_address:
        title: IP address
        type: string
        minLength: 1
        x-nullable: true
      phone_number:
        title: Telephone number
        type: string
        maxLength: 30
        minLength: 1
        x-nullable: true
      external_system_link:
        title: External system link
        description: Link to external system for management of the SIM
        type: string
        format: uri
        maxLength: 200
        minLength: 1
        x-nullable: true
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  StagedMeterReading:
    required:
      - meter_device_name
      - series_name
      - timestamp
      - value
    type: object
    properties:
      id:
        title: Id
        type: integer
        readOnly: true
      meter_device_name:
        title: Name of meter device
        type: string
        maxLength: 50
        minLength: 1
      series_name:
        title: Name of meter reading series
        type: string
        maxLength: 50
        minLength: 1
      timestamp:
        title: Timestamp
        description: Time when the reading was registered in the meter.
        type: string
        format: date-time
      value:
        title: Value
        type: string
        format: decimal
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  Organization:
    required:
      - name
    type: object
    properties:
      id:
        title: Primary Key
        type: string
        format: uuid
        readOnly: true
      name:
        title: Name of organization
        type: string
        maxLength: 64
        minLength: 1
      is_active:
        title: Indicates if organization is active
        type: boolean
      members:
        type: array
        items:
          type: string
          format: uuid
        readOnly: true
        uniqueItems: true
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true
  OrganizationMember:
    required:
      - organization
      - user
    type: object
    properties:
      id:
        title: Id
        type: integer
        readOnly: true
      organization:
        title: Organization
        type: string
        format: uuid
      user:
        title: User
        type: string
        format: uuid
      created_at:
        title: Created at
        type: string
        format: date-time
        readOnly: true
      updated_at:
        title: Updated at
        type: string
        format: date-time
        readOnly: true