🖊️
Moderan API
  • Moderan API
  • Authentication
    • API key & Domain ID
  • Assets
    • Spaces
      • Space sizes
  • Contracts
    • Contracts
      • Contract rent and fees
      • Contract spaces
      • Contract persons
  • Turnover rent
    • Turnover
    • Turnover rent
  • Contacts
    • Organizations
    • Persons
  • Reports
    • Rent and fees calculation
    • Building performance
    • Property performance
    • Spaces
  • Costs API
    • Get Property-Building sets
    • Periods
    • Cost types
    • Bills
    • Contract terms
    • Get Costs for a period
    • Get Cost Rates for a period
    • Send Readings data
  • Classifiers
    • Billing names
    • Distribution Basis
Powered by GitBook
On this page
  • Sending example Reading
  • Send an example Reading to Moderan
  • Sending Readings data to Moderan
  • Send Readings in batch to Moderan

Was this helpful?

  1. Costs API

Send Readings data

Sending data to Moderan Readings database via API

PreviousGet Cost Rates for a periodNextBilling names

Last updated 3 years ago

Was this helpful?

To enable sending Readings data to Moderan via API you need to:

  • Get the ID of the Property/Building set for which you want to send the Reading data

  • Send the example test Reading data, making a POST request

  • Send the batch Readings to the needed set through another POST

To get the COST_SET_ID see:

Sending example Reading

To send an example Reading data to Moderan via API

Send an example Reading to Moderan

POST https://www.moderan.net/api/domains/DOMAIN_ID/readingdumps

This endpoint allows you to send your Readings data into Moderan via POST.

Query Parameters

Name
Type
Description

date

string

date of the meter reading, =YYYY-MM-DD

meter

string

meter name

set

object

object for which you specify the set ID

id

number

COST_SET_ID which you GET from a Property-Building set query

reading

number

reading data of the meter

{    "name": "Cake's name",    "recipe": "Cake's recipe name",    "cake": "Binary cake"}
{    "message": "Ain't no cake like that."}

Example JSON for sending trial Reading data:

{
        "date" : "2019-06-17",
        "meter" : "7JK1P",
        "set" : 
{             "id" : 61          }
,
         "reading" : 3803
}

Sending Readings data to Moderan

Readings data can be send to Moderan in a batch.

Regardless of how many records you want to send to Moderan, you need to use a batch POST method.

Send Readings in batch to Moderan

POST https://www.moderan.net/api/domains/DOMAIN_ID/readingdumps/batch

This endpoint allows you to send your Readings data into Moderan via POST.

Query Parameters

Name
Type
Description

date

string

date of the meter reading, =YYYY-MM-DD

meter

string

meter name

set

object

object for which you specify the set ID

id

number

COST_SET_ID which you GET from a Property-Building set query

reading

number

reading data of the meter

{    "name": "Cake's name",    "recipe": "Cake's recipe name",    "cake": "Binary cake"}
{    "message": "Ain't no cake like that."}

Example JSON for sending Readings data in batch:

{
   "readings":[
      {
         "date":"2021-09-10",
         "meter":"Electricity.1",
         "set":{
            "id":627
         },
         "reading":3803
      },
      {
         "date":"2021-09-10",
         "meter":"Electricity.2",
         "set":{
            "id":627
         },
         "reading":3703
      }
   ]
}
Get Property-Building sets