Overview

Version information

Version : v1

URI scheme

Host : tys.epias.com.tr
BasePath : /ecms-index-metering-data/rest
Schemes : HTTPS

Tags

  • additional-accrual

  • index-metering

About This Document

This document contains application definitions and describes how these services will be invoked.

This is a live document and features may differ between test and production versions.

Changes

1.0.0 Service Definitions

About Application

This application is running on REST services. It consumes JSON and XML requests and produces JSON and XML requests.

You need a authorized user at DGPYS to use these services. Every request needs to be authorize by Central Authentication Server (cas.epias.com.tr).

Generating Clients

Service documentation based on Swagger. You can use following files https://testtys.epias.com.tr/ecms-index-metering-data/test/swagger.json for test environment, https://tys.epias.com.tr/ecms-index-metering-data/test/swagger.json for production environment to generate client. There is a code generator located on https://generator.swagger.io which helps you to build client in any language.

Help and Support

You can send your opinions or support request to gorusleriniz.gop@epias.com.tr mail address.

Application Call Procedure

TGT (Ticket Granting Ticket) controls users session. TGT is active at 45 even if you don’t use it.

You can not use TGT as token to call rest services. For each call you need to create a token (Called ST - Service Token) using TGT. You should reuse TGT.You don’t need to create TGT for each request. If you do that you may blocked by Central Authentication Server.

Ticket Granting Ticket (TGT)

In order to create TGT you can post following request to https://cas.epias.com.tr/cas/v1/tickets?format=text for production or https://testcas.epias.com.tr/cas/v1/tickets?format=text for pre-production environment. Service accepts only POST requests.

HTTP header should contain Content-Type = application/x-www-form-urlencoded key value pair.

parameter value

username

DGPYS user

password

DGPYS password
Raw Http Request
POST /cas/v1/tickets HTTP/1.1
Host: cas.epias.com.tr
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded

username=DGPYSUSER&password=DGPYSPASSWORD

You should wait HTTP 201 status code for successful requests.

Sample Response
TGT-237-U0TU0jUHLyOEIrdoDBEEf3AdRFAXGLifK2ITn4LoY3HfhstGtx-cas02.epias.com.tr

Service Ticket (ST) Procedure

You need to have a valid TGT to create ST. If you have a valid TGT. You need to construct ST request URL. URL should have following format https://cas.epias.com.tr/cas/v1/tickets/{TGT}

You can not reuse ST.
ST is valid for 30 seconds.
Service name is for production https://tysapi.epias.com.tr and https://testtysapi.epias.com.tr for test
Sample URL
https://cas.epias.com.tr/cas/v1/tickets/TGT-229-2hmcHafszagAAxtCh017nax1en3U9TouWeGvIrq9KbSbeKE9Zk-cas02.epias.com.tr

You should post following parameter as an input using POST method.

parameter value

service

for test environment : https://testtysapi.epias.com.tr, for production environment https://tysapi.epias.com.tr

You get following response after you call the operation. If you should wait for HTTP 200 status code for successful requests.

Sample Response
ST-29962-hSwyzWCP0xC0eRi0bmna-cas01.epias.com.tr

Base Message Format

Gun Oncesi Application has a standart message format.

Every http request should contain following HTTP headers.

key value

ecms-service-ticket

Service Ticket (ST) e.g. : ST-30247-uNWazHn52sKZU71v5Ar4-cas02.epias.com.tr

Accept

application/json or application/xml

Content-Type

application/json or application/xml

Accept-Language

tr-tr or en-us (english version is in testing stage)

Service messages are splitted in two parts.

First part is called header which defines your requests. This area is independent from service bussiness logic. header should contain following key value pair.

key value description

transactionId

this should be unique (Universal Unique Identifier)

we will request this value if you have some trouble using rest services.

application

your application name

Second part called body. This part may differ across all other services.

Following request validates delivery day for offer services.

header is a (key) (value) pair area.
All services uses ISO-8601 as date-time format. Format : yyyy-MM-dd’T’HH:mm:ss.SSSZ. You should use Europe/Istanbul as timezone. Timezone may differ daylight saving days. Sample : 2016-03-25T00:00:00.000+0300
Example ISO8601 Parser for Java 8
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;

public class DateUtil
{

    public static Date fromISO8601Date(String v)
    {
        if (null == v) return null;
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
        try
        {
            return sdf.parse(v);
        } catch (ParseException e)
        {
            throw new RuntimeException(e);
        }
    }

    public static String toISO8601Date(Date v)
    {
        if (null == v) return null;
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSZ");
        return sdf.format(v);
    }
}
Example HTTP Request
POST /ecms-unregistered-metering-point/rest/ump/list HTTP/1.1
Host: testtysapi.epias.com.tr
Accept: application/json
Content-Type: application/json
ecms-service-ticket: ST-31352-VjHOo5iDV4fDkOod3jZc-cas02.epias.com.tr
Cache-Control: no-cache

{
   "header":[
      {
         "key":"transactionId",
         "value":"6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
      },
      {
         "key":"application",
         "value":"UYGULAMA_ADI"
      }
   ],
   "body":{
      "settlementPeriod":"2016-06-01T00:00:00.000+0300",
      "requestStatuses":["WAITING","INVALID_DISTRIBUTION_METER_CODE","INSUFFICENT_LIMIT","APPROVED"]
   }
}
Example JSON Request
{
   "resultCode":"0",
   "resultDescription":"OK",
   "resultType":"SUCCESS",
   "body":{
      "queryInformation":{
         "begin":1,
         "end":10000,
         "count":3
      },
      "unregisteredMeteringPoints":[
         {
            "requestId":1,
            "requestDate":"2016-10-03T13:34:43.000+0300",
            "reportingDate":null,
            "distributionMeterCode":"  M328",
            "eic":"40Z000007531577H",
            "requestStatus":"APPROVED",
            "requestedCompany":{
               "organizationId":9327,
               "eic":"40X000000009327Q",
               "name":"ERZURUM 1.ORGANİZE SANAYİ BÖLGE MÜDÜRLÜĞÜ",
               "shortname":"ERZ.1-OSB"
            },
            "requestingCompany":{
               "organizationId":195,
               "eic":"40X000000000195P",
               "name":"ELEKTRİK ÜRETİM A.Ş.",
               "shortname":"EÜAŞ"
            },
            "recordingUser":"PK195",
            "reportingUser":null
         },
         {
            "requestId":2,
            "requestDate":"2016-10-03T13:34:45.000+0300",
            "reportingDate":null,
            "distributionMeterCode":"uasxprsc",
            "eic":null,
            "requestStatus":"WAITING",
            "requestedCompany":{
               "organizationId":649,
               "eic":"40X000000000649C",
               "name":"1. BÖLGE MÜDÜRLÜĞÜ",
               "shortname":"1 Iletim"
            },
            "requestingCompany":{
               "organizationId":195,
               "eic":"40X000000000195P",
               "name":"ELEKTRİK ÜRETİM A.Ş.",
               "shortname":"EÜAŞ"
            },
            "recordingUser":"PK195",
            "reportingUser":null
         },
         {
            "requestId":3,
            "requestDate":"2016-10-03T13:38:41.000+0300",
            "reportingDate":null,
            "distributionMeterCode":"123123",
            "eic":null,
            "requestStatus":"WAITING",
            "requestedCompany":{
               "organizationId":649,
               "eic":"40X000000000649C",
               "name":"1. BÖLGE MÜDÜRLÜĞÜ",
               "shortname":"1 Iletim"
            },
            "requestingCompany":{
               "organizationId":195,
               "eic":"40X000000000195P",
               "name":"ELEKTRİK ÜRETİM A.Ş.",
               "shortname":"EÜAŞ"
            },
            "recordingUser":"PK195",
            "reportingUser":null
         }
      ]
   }
}

Response contains two section. Fields start with result describes whether your reques is valid or not. Section body contains response.

Every response contains following fields

parameter type value description

resultCode

string

"0" means success other values may differ for each request

if you had a problem we will ask this value.

resultDescription

string

if requests succeed return "OK" otherwise returs error description

.

resultType

string

returns SUCCESS for valid operation, if you violate a business rule you will get BUSINESSERROR , if our system can not process your request, you will get SYSTEMERROR
BUSINESSERROR : This means you send an invalid request. Check your input. if you belive your request is valid contact with us. SYSTEMERROR : This means we can not process your request. You should contact with us.
Sample Success Message
{"resultCode":"0","resultDescription":"OK","body":true,"resultType":"SUCCESS"}

Service Details

From this point document contains service description and call details.

1. Index Metering Rest Service

1.1. How to save index metering?

Service parameter details can be accessed from here.

Example XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<indexMeteringSaveRequest>
        <header>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </header>
        <header>
                <key>application</key>
                <value>gopweb</value>
        </header>
        <header>
                <key>clientIp</key>
                <value>127001</value>
        </header>
        <body>
                <indexes>
                        <period>2016-10-01</period>
                        <meteringPointId>12345</meteringPointId>
                        <meterBrand>EMH</meterBrand>
                        <meterSerialNumber>ABS123DEF</meterSerialNumber>
                        <meterType>ELECTRONIC</meterType>
                        <powerType>INDUCTIVE</powerType>
                        <factor>1</factor>
                        <firstMeasureDate>2016-07-01</firstMeasureDate>
                        <firstMeasureType>PERIODIC</firstMeasureType>
                        <firstLoadType>MANUALLY</firstLoadType>
                        <firstT0 />
                        <firstT1>1</firstT1>
                        <firstT2>1</firstT2>
                        <firstT3>1</firstT3>
                        <lastMeasureDate>2016-07-31</lastMeasureDate>
                        <lastMeasureType>PERIODIC</lastMeasureType>
                        <lastLoadType>MANUALLY</lastLoadType>
                        <lastT0 />
                        <lastT1>2</lastT1>
                        <lastT2>2</lastT2>
                        <lastT3>2</lastT3>
                        <description>endeks ölçümü</description>
                        <digitCount>9</digitCount>
                </indexes>
        </body>
</indexMeteringSaveRequest>
Example XML Response
<?xml version="1.0" encoding="UTF-8" ?>
<indexMeteringSaveResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS</resultType>
        <body>
                <indexes>
                        <indexId>112233</indexId>
                        <period>2016-10-01</period>
                        <meteringPointId>12345</meteringPointId>
                        <meterBrand>EMH</meterBrand>
                        <meterSerialNumber>ABS123DEF</meterSerialNumber>
                        <meterType>ELECTRONIC</meterType>
                        <powerType>ACTIVE</powerType>
                        <factor>1</factor>
                        <firstMeasureDate>2016-07-01</firstMeasureDate>
                        <firstMeasureType>PERIODIC</firstMeasureType>
                        <firstLoadType>MANUALLY</firstLoadType>
                        <firstT0 />
                        <firstT1>1</firstT1>
                        <firstT2>1</firstT2>
                        <firstT3>1</firstT3>
                        <lastMeasureDate>2016-07-31</lastMeasureDate>
                        <lastMeasureType>PERIODIC</lastMeasureType>
                        <lastLoadType>MANUALLY</lastLoadType>
                        <lastT0 />
                        <lastT1>2</lastT1>
                        <lastT2>2</lastT2>
                        <lastT3>2</lastT3>
                        <description>endeks ölçümü</description>
                        <digitCount>9</digitCount>
                        <status>ACTIVE</status>
                        <state>Kaydedildi.</state>
                </indexes>
        </body>
</indexMeteringSaveResponse>
Example Json Request
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "indexes": [
            {
                    "period":"2016-10-01",
                    "meteringPointId":12345,
                    "meterBrand":"EMH",
                    "meterSerialNumber": "ABC123DEF",
                    "meterType":"ELECTRONIC",
                    "powerType":"ACTIVE",
                    "factor":1,
                    "firstMeasureDate":"2016-07-01",
                    "firstMeasureType":"PERIODIC",
                    "firstLoadType":"MANUALLY",
                    "firstT0":null,
                    "firstT1":1,
                    "firstT2":1,
                    "firstT3":1,
                    "lastMeasureDate":"2016-07-31",
                    "lastMeasureType":"PERIODIC",
                    "lastLoadType":"MANUALLY",
                    "lastT0":null,
                    "lastT1":2,
                    "lastT2":2,
                    "lastT3":2,
                    "description":"endeks ölçümü",
                "digitCount": 9
            }
    ]
  }
}
Example Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "indexes": [
      {
        "indexId": 112233,
        "period": "2016-10-01",
        "meteringPointId": 12345,
        "meterBrand": "EMH",
        "meterSerialNumber": "ABS123DEF",
        "meterType": "ELECTRONIC",
        "powerType": "ACTIVE",
        "factor": 1,
        "firstMeasureDate": "2016-07-01",
        "firstMeasureType": "PERIODIC",
        "firstLoadType": "MANUALLY",
        "firstT0": null,
        "firstT1": 1,
        "firstT2": 1,
        "firstT3": 1,
        "lastMeasureDate": "2016-07-31",
        "lastMeasureType": "PERIODIC",
        "lastLoadType": "MANUALLY",
        "lastT0": null,
        "lastT1": 2,
        "lastT2": 2,
        "lastT3": 2,
        "description": "endeks ölçümü",
        "digitCount": 9,
        "status": "ACTIVE",
        "state": "Kaydedildi."
      }
    ]
  }
}

1.2. How to query saved index metering records??

Service parameter details can be accessed from here.

Example XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<indexMeteringSearchRequest>
        <header>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </header>
        <header>
                <key>application</key>
                <value>gopweb</value>
        </header>
        <header>
                <key>clientIp</key>
                <value>127001</value>
        </header>
        <body>
                <criterias>
                        <meteringPointId>15405</meteringPointId>
                        <meterSerialNumber>12313123123</meterSerialNumber>
                        <period>2016-06-01</period>
                        <firstMeasureDate>2014-06-01</firstMeasureDate>
                        <lastMeasureDate>2014-06-05</lastMeasureDate>
                        <measuringOrgId>1023</measuringOrgId>
                        <recordDateBegin>2016-10-01T00:00:00.000+0300</recordDateBegin>
                        <recordDateEnd>2016-10-30T00:00:00.000+0300</recordDateEnd>
                </criterias>
                <range>
                        <begin>1</begin>
                        <end>3</end>
                </range>
        </body>
</indexMeteringSearchRequest>
Example XML Response
<?xml version="1.0" encoding="UTF-8" ?>
<indexMeteringSearchResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS</resultType>
        <body>
                <queryInformation>
                        <begin>1</begin>
                        <count>12534</count>
                        <end>3</end>
                </queryInformation>
                <indexes>
                        <indexId>40065</indexId>
                        <period>2016-06-01</period>
                        <meteringPointId>15405</meteringPointId>
                        <meterBrand>dsgfsd</meterBrand>
                        <meterSerialNumber>12313123123</meterSerialNumber>
                        <meterType>ELECTRONIC</meterType>
                        <powerType>ACTIVE</powerType>
                        <factor>6</factor>
                        <firstMeasureDate>2014-06-01</firstMeasureDate>
                        <firstMeasureType>METER_CHANGING_ASSEMBLY</firstMeasureType>
                        <firstLoadType>AUTOMATED</firstLoadType>
                        <firstT0 />
                        <firstT1>6.546</firstT1>
                        <firstT2>6</firstT2>
                        <firstT3>1</firstT3>
                        <lastMeasureDate>2014-06-05</lastMeasureDate>
                        <lastMeasureType>SUBSCRIPTION</lastMeasureType>
                        <lastLoadType>MANUALLY</lastLoadType>
                        <lastT0 />
                        <lastT1>9999999999.999</lastT1>
                        <lastT2>6</lastT2>
                        <lastT3>1</lastT3>
                        <description>sdfsdfsd</description>
                        <status>OLD_VERSION</status>
                        <state>VALID</state>
                        <supplierOrgId>9612</supplierOrgId>
                        <transformerLoss>0</transformerLoss>
                        <lineLoss>0</lineLoss>
                        <digitCount>9</digitCount>
                </indexes>
                <indexes>
                        <indexId>40069</indexId>
                        <period>2016-06-01</period>
                        <meteringPointId>15405</meteringPointId>
                        <meterBrand>dsgfsd</meterBrand>
                        <meterSerialNumber>12313123123</meterSerialNumber>
                        <meterType>ELECTRONIC</meterType>
                        <powerType>ACTIVE</powerType>
                        <factor>6</factor>
                        <firstMeasureDate>2014-06-01</firstMeasureDate>
                        <firstMeasureType>METER_CHANGING_ASSEMBLY</firstMeasureType>
                        <firstLoadType>AUTOMATED</firstLoadType>
                        <firstT0 />
                        <firstT1>6.546</firstT1>
                        <firstT2>6</firstT2>
                        <firstT3>1</firstT3>
                        <lastMeasureDate>2014-06-05</lastMeasureDate>
                        <lastMeasureType>SUBSCRIPTION</lastMeasureType>
                        <lastLoadType>MANUALLY</lastLoadType>
                        <lastT0 />
                        <lastT1>9999999999.999</lastT1>
                        <lastT2>666.5</lastT2>
                        <lastT3>1</lastT3>
                        <description>sdfsdfsd</description>
                        <status>OLD_VERSION</status>
                        <state>VALID</state>
                        <supplierOrgId>9612</supplierOrgId>
                        <transformerLoss>0</transformerLoss>
                        <lineLoss>0</lineLoss>
                        <digitCount>9</digitCount>
                </indexes>
                <indexes>
                        <indexId>40071</indexId>
                        <period>2016-06-01</period>
                        <meteringPointId>15405</meteringPointId>
                        <meterBrand>dsgfsd</meterBrand>
                        <meterSerialNumber>12313123123</meterSerialNumber>
                        <meterType>ELECTRONIC</meterType>
                        <powerType>ACTIVE</powerType>
                        <factor>6</factor>
                        <firstMeasureDate>2014-06-01</firstMeasureDate>
                        <firstMeasureType>METER_CHANGING_ASSEMBLY</firstMeasureType>
                        <firstLoadType>AUTOMATED</firstLoadType>
                        <firstT0 />
                        <firstT1>6.546</firstT1>
                        <firstT2>6</firstT2>
                        <firstT3>1</firstT3>
                        <lastMeasureDate>2014-06-05</lastMeasureDate>
                        <lastMeasureType>SUBSCRIPTION</lastMeasureType>
                        <lastLoadType>MANUALLY</lastLoadType>
                        <lastT0 />
                        <lastT1>9999999999.999</lastT1>
                        <lastT2>666.5</lastT2>
                        <lastT3>1</lastT3>
                        <description>sdfsdfsd</description>
                        <status>OLD_VERSION</status>
                        <state>VALID</state>
                        <supplierOrgId>9612</supplierOrgId>
                        <transformerLoss>0</transformerLoss>
                        <lineLoss>0</lineLoss>
                        <digitCount>9</digitCount>
                </indexes>
        </body>
</indexMeteringSearchResponse>
Example Json Request
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "criterias": {
            "meteringPointId":15405,
            "meterSerialNumber":"12313123123",
            "period":"2016-06-01",
            "firstMeasureDate":"2014-06-01",
            "lastMeasureDate":"2014-06-05",
            "measuringOrgId":1023,
            "recordDateBegin":"2016-10-01T00:00:00.000+0300",
            "recordDateEnd":"2016-10-30T00:00:00.000+0300"
    },
    "range": {
            "begin":1,
            "end": 3
    }
  }
}
Example Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
          "queryInformation": {
      "begin": 1,
      "end": 3,
      "count": 12534
    },
    "indexes": [
      {
        "indexId": 40065,
        "period": "2016-06-01T00:00:00.000+0300",
        "meteringPointId": 15405,
        "meterBrand": "dsgfsd",
        "meterSerialNumber": "12313123123",
        "meterType": "ELECTRONIC",
        "powerType": "ACTIVE",
        "factor": 6,
        "firstMeasureDate": "2014-06-01T23:59:00.000+0300",
        "firstMeasureType": "METER_CHANGING_ASSEMBLY",
        "firstLoadType": "AUTOMATED",
        "firstT0": null,
        "firstT1": 6.546,
        "firstT2": 6,
        "firstT3": 1,
        "lastMeasureDate": "2014-06-05T00:01:00.000+0300",
        "lastMeasureType": "SUBSCRIPTION",
        "lastLoadType": "MANUALLY",
        "lastT0": null,
        "lastT1": 9999999999.999,
        "lastT2": 6,
        "lastT3": 1,
        "description": "sdfsdfsd",
        "status": "OLD_VERSION",
        "state": "VALID",
        "supplierOrgId": 9612,
        "transformerLoss": 0,
        "lineLoss": 0,
        "digitCount": 9
      },
      {
        "indexId": 40069,
        "period": "2016-06-01T00:00:00.000+0300",
        "meteringPointId": 15405,
        "meterBrand": "dsgfsd",
        "meterSerialNumber": "12313123123",
        "meterType": "ELECTRONIC",
        "powerType": "ACTIVE",
        "factor": 6,
        "firstMeasureDate": "2014-06-01T23:59:00.000+0300",
        "firstMeasureType": "METER_CHANGING_ASSEMBLY",
        "firstLoadType": "AUTOMATED",
        "firstT0": null,
        "firstT1": 6.546,
        "firstT2": 6,
        "firstT3": 1,
        "lastMeasureDate": "2014-06-05T00:01:00.000+0300",
        "lastMeasureType": "SUBSCRIPTION",
        "lastLoadType": "MANUALLY",
        "lastT0": null,
        "lastT1": 9999999999.999,
        "lastT2": 666.5,
        "lastT3": 1,
        "description": "sdfsdfsd",
        "status": "OLD_VERSION",
        "state": "VALID",
        "supplierOrgId": 9612,
        "transformerLoss": 0,
        "lineLoss": 0,
        "digitCount": 9
      },
      {
        "indexId": 40071,
        "period": "2016-06-01T00:00:00.000+0300",
        "meteringPointId": 15405,
        "meterBrand": "dsgfsd",
        "meterSerialNumber": "12313123123",
        "meterType": "ELECTRONIC",
        "powerType": "ACTIVE",
        "factor": 6,
        "firstMeasureDate": "2014-06-01T23:59:00.000+0300",
        "firstMeasureType": "METER_CHANGING_ASSEMBLY",
        "firstLoadType": "AUTOMATED",
        "firstT0": null,
        "firstT1": 6.546,
        "firstT2": 6,
        "firstT3": 1,
        "lastMeasureDate": "2014-06-05T00:01:00.000+0300",
        "lastMeasureType": "SUBSCRIPTION",
        "lastLoadType": "MANUALLY",
        "lastT0": null,
        "lastT1": 9999999999.999,
        "lastT2": 666.5,
        "lastT3": 1,
        "description": "sdfsdfsd",
        "status": "OLD_VERSION",
        "state": "VALID",
        "supplierOrgId": 9612,
        "transformerLoss": 0,
        "lineLoss": 0,
        "digitCount": 9
      }
    ]
  }
}

1.3. How to query saved index metering records with index ID information?

Service parameter details can be accessed from here.

Example XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<indexMeteringFindRequest>
        <header>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </header>
        <header>
                <key>application</key>
                <value>gopweb</value>
        </header>
        <header>
                <key>clientIp</key>
                <value>127001</value>
        </header>
        <body>
                <indexIds>40065</indexIds>
                <indexIds>40069</indexIds>
                <indexIds>40071</indexIds>
        </body>
</indexMeteringFindRequest>
Example XML Response
<?xml version="1.0" encoding="UTF-8" ?>
<indexMeteringFindResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS</resultType>
        <body>
                <indexes>
                        <indexId>40065</indexId>
                        <period>2016-06-01</period>
                        <meteringPointId>15405</meteringPointId>
                        <meterBrand>dsgfsd</meterBrand>
                        <meterSerialNumber>12313123123</meterSerialNumber>
                        <meterType>ELECTRONIC</meterType>
                        <powerType>ACTIVE</powerType>
                        <factor>6</factor>
                        <firstMeasureDate>2014-06-01</firstMeasureDate>
                        <firstMeasureType>METER_CHANGING_ASSEMBLY</firstMeasureType>
                        <firstLoadType>AUTOMATED</firstLoadType>
                        <firstT0 />
                        <firstT1>6.546</firstT1>
                        <firstT2>6</firstT2>
                        <firstT3>1</firstT3>
                        <lastMeasureDate>2014-06-05</lastMeasureDate>
                        <lastMeasureType>SUBSCRIPTION</lastMeasureType>
                        <lastLoadType>MANUALLY</lastLoadType>
                        <lastT0 />
                        <lastT1>9999999999.999</lastT1>
                        <lastT2>6</lastT2>
                        <lastT3>1</lastT3>
                        <description>sdfsdfsd</description>
                        <status>OLD_VERSION</status>
                        <state>VALID</state>
                        <supplierOrgId>9612</supplierOrgId>
                        <transformerLoss>0</transformerLoss>
                        <lineLoss>0</lineLoss>
                        <digitCount>9</digitCount>
                </indexes>
                <indexes>
                        <indexId>40069</indexId>
                        <period>2016-06-01</period>
                        <meteringPointId>15405</meteringPointId>
                        <meterBrand>dsgfsd</meterBrand>
                        <meterSerialNumber>12313123123</meterSerialNumber>
                        <meterType>ELECTRONIC</meterType>
                        <powerType>ACTIVE</powerType>
                        <factor>6</factor>
                        <firstMeasureDate>2014-06-01</firstMeasureDate>
                        <firstMeasureType>METER_CHANGING_ASSEMBLY</firstMeasureType>
                        <firstLoadType>AUTOMATED</firstLoadType>
                        <firstT0 />
                        <firstT1>6.546</firstT1>
                        <firstT2>6</firstT2>
                        <firstT3>1</firstT3>
                        <lastMeasureDate>2014-06-05</lastMeasureDate>
                        <lastMeasureType>SUBSCRIPTION</lastMeasureType>
                        <lastLoadType>MANUALLY</lastLoadType>
                        <lastT0 />
                        <lastT1>9999999999.999</lastT1>
                        <lastT2>666.5</lastT2>
                        <lastT3>1</lastT3>
                        <description>sdfsdfsd</description>
                        <status>OLD_VERSION</status>
                        <state>VALID</state>
                        <supplierOrgId>9612</supplierOrgId>
                        <transformerLoss>0</transformerLoss>
                        <lineLoss>0</lineLoss>
                        <digitCount>9</digitCount>
                </indexes>
                <indexes>
                        <indexId>40071</indexId>
                        <period>2016-06-01</period>
                        <meteringPointId>15405</meteringPointId>
                        <meterBrand>dsgfsd</meterBrand>
                        <meterSerialNumber>12313123123</meterSerialNumber>
                        <meterType>ELECTRONIC</meterType>
                        <powerType>ACTIVE</powerType>
                        <factor>6</factor>
                        <firstMeasureDate>2014-06-01</firstMeasureDate>
                        <firstMeasureType>METER_CHANGING_ASSEMBLY</firstMeasureType>
                        <firstLoadType>AUTOMATED</firstLoadType>
                        <firstT0 />
                        <firstT1>6.546</firstT1>
                        <firstT2>6</firstT2>
                        <firstT3>1</firstT3>
                        <lastMeasureDate>2014-06-05</lastMeasureDate>
                        <lastMeasureType>SUBSCRIPTION</lastMeasureType>
                        <lastLoadType>MANUALLY</lastLoadType>
                        <lastT0 />
                        <lastT1>9999999999.999</lastT1>
                        <lastT2>666.5</lastT2>
                        <lastT3>1</lastT3>
                        <description>sdfsdfsd</description>
                        <status>OLD_VERSION</status>
                        <state>VALID</state>
                        <supplierOrgId>9612</supplierOrgId>
                        <transformerLoss>0</transformerLoss>
                        <lineLoss>0</lineLoss>
                        <digitCount>9</digitCount>
                </indexes>
        </body>
</indexMeteringFindResponse>
Example Json Request
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "indexIds": [40065,40069,40071]
  }
}
Example Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "indexes": [
      {
        "indexId": 40065,
        "period": "2016-06-01",
        "meteringPointId": 15405,
        "meterBrand": "dsgfsd",
        "meterSerialNumber": "12313123123",
        "meterType": "ELECTRONIC",
        "powerType": "ACTIVE",
        "factor": 6,
        "firstMeasureDate": "2014-06-01",
        "firstMeasureType": "METER_CHANGING_ASSEMBLY",
        "firstLoadType": "AUTOMATED",
        "firstT0": null,
        "firstT1": 6.546,
        "firstT2": 6,
        "firstT3": 1,
        "lastMeasureDate": "2014-06-05",
        "lastMeasureType": "SUBSCRIPTION",
        "lastLoadType": "MANUALLY",
        "lastT0": null,
        "lastT1": 9999999999.999,
        "lastT2": 6,
        "lastT3": 1,
        "description": "sdfsdfsd",
        "status": "OLD_VERSION",
        "state": "VALID",
        "supplierOrgId": 9612,
        "transformerLoss": 0,
        "lineLoss": 0,
        "digitCount": 9
      },
      {
        "indexId": 40069,
        "period": "2016-06-01",
        "meteringPointId": 15405,
        "meterBrand": "dsgfsd",
        "meterSerialNumber": "12313123123",
        "meterType": "ELECTRONIC",
        "powerType": "ACTIVE",
        "factor": 6,
        "firstMeasureDate": "2014-06-01",
        "firstMeasureType": "METER_CHANGING_ASSEMBLY",
        "firstLoadType": "AUTOMATED",
        "firstT0": null,
        "firstT1": 6.546,
        "firstT2": 6,
        "firstT3": 1,
        "lastMeasureDate": "2014-06-05",
        "lastMeasureType": "SUBSCRIPTION",
        "lastLoadType": "MANUALLY",
        "lastT0": null,
        "lastT1": 9999999999.999,
        "lastT2": 666.5,
        "lastT3": 1,
        "description": "sdfsdfsd",
        "status": "OLD_VERSION",
        "state": "VALID",
        "supplierOrgId": 9612,
        "transformerLoss": 0,
        "lineLoss": 0,
        "digitCount": 9
      },
      {
        "indexId": 40071,
        "period": "2016-06-01",
        "meteringPointId": 15405,
        "meterBrand": "dsgfsd",
        "meterSerialNumber": "12313123123",
        "meterType": "ELECTRONIC",
        "powerType": "ACTIVE",
        "factor": 6,
        "firstMeasureDate": "2014-06-01",
        "firstMeasureType": "METER_CHANGING_ASSEMBLY",
        "firstLoadType": "AUTOMATED",
        "firstT0": null,
        "firstT1": 6.546,
        "firstT2": 6,
        "firstT3": 1,
        "lastMeasureDate": "2014-06-05",
        "lastMeasureType": "SUBSCRIPTION",
        "lastLoadType": "MANUALLY",
        "lastT0": null,
        "lastT1": 9999999999.999,
        "lastT2": 666.5,
        "lastT3": 1,
        "description": "sdfsdfsd",
        "status": "OLD_VERSION",
        "state": "VALID",
        "supplierOrgId": 9612,
        "transformerLoss": 0,
        "lineLoss": 0,
        "digitCount": 9
      }
    ]
  }
}

1.4. How to cancel active index metering records?

Service parameter details can be accessed from here.

Example XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<indexMeteringCancelRequest>
        <header>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </header>
        <header>
                <key>application</key>
                <value>gopweb</value>
        </header>
        <header>
                <key>clientIp</key>
                <value>127001</value>
        </header>
        <body>
                <indexIds>40046</indexIds>
                <indexIds>40123</indexIds>
                <indexIds>40144</indexIds>
        </body>
</indexMeteringCancelRequest>
Example XML Response
<?xml version="1.0" encoding="UTF-8" ?>
<indexMeteringCancelResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS</resultType>
        <body>
                <cancelledIndexes>40046</cancelledIndexes>
                <cancelledIndexes>40123</cancelledIndexes>
                <cancelledIndexes>40144</cancelledIndexes>
        </body>
</indexMeteringCancelResponse>
Example Json Request
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "indexIds": [40046,40123,40144]
  }
}
Example Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "cancelledIndexes": [
      40046,
      40123,
      40144
    ]
  }
}

2. Additional Consumption Rest Service

2.1. How to save additional consumption?

Service parameter details can be accessed from here.

Example XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<additionalAccrualSaveRequest>
        <header>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </header>
        <header>
                <key>application</key>
                <value>gopweb</value>
        </header>
        <header>
                <key>clientIp</key>
                <value>127001</value>
        </header>
        <body>
                <additionalAccruals>
                        <period>2016-07-01</period>
                        <meteringPointId>12345</meteringPointId>
                        <startDate>2016-08-01</startDate>
                        <endDate>2016-08-31</endDate>
                        <t0>1</t0>
                        <t1>1</t1>
                        <t2>1</t2>
                        <t3>1</t3>
                        <ri>1</ri>
                        <rc>1</rc>
                        <demand>1</demand>
                        <reason>MEASURING_ERROR</reason>
                        <description></description>
                </additionalAccruals>
        </body>
</additionalAccrualSaveRequest>
Example XML Response
<?xml version="1.0" encoding="UTF-8" ?>
<additionalAccrualSaveResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS</resultType>
        <body>
                <additionalAccruals>
                        <additionalAccrualId>112233</additionalAccrualId>
                        <period>2016-07-01</period>
                        <meteringPointId>12345</meteringPointId>
                        <startDate>2016-08-01</startDate>
                        <endDate>2016-08-31</endDate>
                        <t0>1</t0>
                        <t1>1</t1>
                        <t2>1</t2>
                        <t3>1</t3>
                        <ri>1</ri>
                        <rc>1</rc>
                        <demand>1</demand>
                        <reason>MEASURING_ERROR</reason>
                        <description></description>
                        <state>Kaydedildi.</state>
                </additionalAccruals>
        </body>
</additionalAccrualSaveResponse>
Example Json Request
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "additionalAccruals": [
            {
                    "period":"2016-07-01",
                    "meteringPointId":12345,
                    "startDate":"2016-08-01",
                    "endDate":"2016-08-31",
                    "t0":1,
                    "t1":1,
                    "t2":1,
                    "t3":1,
                    "ri":1,
                    "rc":1,
                    "demand":1,
                    "reason":"MEASURING_ERROR",
                    "description":""
            }
    ]
  }
}
Example Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "additionalAccruals": [
      {
        "additionalAccrualId": 112233,
                "period":"2016-07-01",
                "meteringPointId":12345,
                "startDate":"2016-08-01",
                "endDate":"2016-08-31",
                "t0":1,
                "t1":1,
                "t2":1,
                "t3":1,
                "ri":1,
                "rc":1,
                "demand":1,
                "reason":"MEASURING_ERROR",
                "description":"",
        "state": "Kaydedildi."
      }
    ]
  }
}

2.2. How to query saved additional consumption records?

Service parameter details can be accessed from here.

Example XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<additionalAccrualSearchRequest>
        <header>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </header>
        <header>
                <key>application</key>
                <value>gopweb</value>
        </header>
        <header>
                <key>clientIp</key>
                <value>127001</value>
        </header>
        <body>
                <criterias>
                        <meteringPointId>12345</meteringPointId>
                        <period>2016-06-01</period>
                        <startDate>2014-06-01</startDate>
                        <endDate>2014-06-05</endDate>
                        <measuringOrgId>1023</measuringOrgId>
                        <recordDateBegin>2016-10-01T00:00:00.000+0300</recordDateBegin>
                        <recordDateEnd>2016-10-30T00:00:00.000+0300</recordDateEnd>
                </criterias>
                <range>
                        <begin>1</begin>
                        <end>2</end>
                </range>
        </body>
</additionalAccrualSearchRequest>
Example XML Response
<?xml version="1.0" encoding="UTF-8" ?>
<additionalAccrualSearchResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS</resultType>
        <body>
                <queryInformation>
                        <begin>1</begin>
                        <count>12534</count>
                        <end>2</end>
                </queryInformation>
                <additionalAccruals>
                        <additionalAccrualId>58372</additionalAccrualId>
                        <period>2016-06-01</period>
                        <meteringPointId>12345</meteringPointId>
                        <startDate>2016-06-02</startDate>
                        <endDate>2016-06-04</endDate>
                        <t0>5</t0>
                        <t1>2</t1>
                        <t2>4</t2>
                        <t3>6</t3>
                        <ri>1</ri>
                        <rc>3</rc>
                        <demand>8</demand>
                        <description>MEASURING_ERROR</description>
                        <state>Geçerli.</state>
                </additionalAccruals>
                <additionalAccruals>
                        <additionalAccrualId>58563</additionalAccrualId>
                        <period>2016-06-01</period>
                        <meteringPointId>12345</meteringPointId>
                        <startDate>2016-06-02</startDate>
                        <endDate>2016-06-04</endDate>
                        <t0>7</t0>
                        <t1>6</t1>
                        <t2>1</t2>
                        <t3>4</t3>
                        <ri>2</ri>
                        <rc>9</rc>
                        <demand>5</demand>
                        <description>MEASURING_ERROR</description>
                        <state>Geçerli.</state>
                </additionalAccruals>
        </body>
</additionalAccrualSearchResponse>
Example Json Request
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "criterias": {
            "meteringPointId":12345,
            "period":"2016-06-01",
            "startDate":"2014-06-01",
            "endDate":"2014-06-05",
            "measuringOrgId":1023,
            "recordDateBegin":"2016-10-01T00:00:00.000+0300",
            "recordDateEnd":"2016-10-30T00:00:00.000+0300"
    },
    "range": {
            "begin":1,
            "end": 2
    }
  }
}
Example Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "queryInformation": {
      "begin": 1,
      "end": 2,
      "count": 12534
    },
    "additionalAccruals": [
      {
        "additionalAccrualId": 58372,
                "period":"2016-06-01",
                "meteringPointId":12345,
                "startDate":"2016-06-02",
                "endDate":"2016-06-04",
                "t0":5,
                "t1":2,
                "t2":4,
                "t3":6,
                "ri":1,
                "rc":3,
                "demand":8,
                "description":"MEASURING_ERROR",
        "state": "Geçerli."
      },
      {
        "additionalAccrualId": 58563,
                "period":"2016-06-01",
                "meteringPointId":12345,
                "startDate":"2016-06-02",
                "endDate":"2016-06-04",
                "t0":7,
                "t1":6,
                "t2":1,
                "t3":4,
                "ri":2,
                "rc":9,
                "demand":5,
                "description":"MEASURING_ERROR",
        "state": "Geçerli."
      }
    ]
  }
}

2.3. How to query saved additional consumption records with ID information?

Service parameter details can be accessed from here.

Example XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<additionalAccrualFindRequest>
        <header>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </header>
        <header>
                <key>application</key>
                <value>gopweb</value>
        </header>
        <header>
                <key>clientIp</key>
                <value>127001</value>
        </header>
        <body>
                <additionalAccrualIds>58372</additionalAccrualIds>
                <additionalAccrualIds>58563</additionalAccrualIds>
        </body>
</additionalAccrualFindRequest>
Example XML Response
<?xml version="1.0" encoding="UTF-8" ?>
<additionalAccrualFindResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS</resultType>
        <body>
                <additionalAccruals>
                        <additionalAccrualId>58372</additionalAccrualId>
                        <period>2016-06-01</period>
                        <meteringPointId>12345</meteringPointId>
                        <startDate>2016-06-02</startDate>
                        <endDate>2016-06-04</endDate>
                        <t0>5</t0>
                        <t1>2</t1>
                        <t2>4</t2>
                        <t3>6</t3>
                        <ri>1</ri>
                        <rc>3</rc>
                        <demand>8</demand>
                        <description>MEASURING_ERROR</description>
                        <state>Geçerli.</state>
                </additionalAccruals>
                <additionalAccruals>
                        <additionalAccrualId>58563</additionalAccrualId>
                        <period>2016-06-01</period>
                        <meteringPointId>12345</meteringPointId>
                        <startDate>2016-06-02</startDate>
                        <endDate>2016-06-04</endDate>
                        <t0>7</t0>
                        <t1>6</t1>
                        <t2>1</t2>
                        <t3>4</t3>
                        <ri>2</ri>
                        <rc>9</rc>
                        <demand>5</demand>
                        <description>MEASURING_ERROR</description>
                        <state>Geçerli.</state>
                </additionalAccruals>
        </body>
</additionalAccrualFindResponse>
Example Json Request
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "additionalAccrualIds": [58372,58563]
  }
}
Example Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "additionalAccruals": [
      {
        "additionalAccrualId": 58372,
                "period":"2016-06-01",
                "meteringPointId":12345,
                "startDate":"2016-06-02",
                "endDate":"2016-06-04",
                "t0":5,
                "t1":2,
                "t2":4,
                "t3":6,
                "ri":1,
                "rc":3,
                "demand":8,
                "description":"MEASURING_ERROR",
        "state": "Geçerli."
      },
      {
        "additionalAccrualId": 58563,
                "period":"2016-06-01",
                "meteringPointId":12345,
                "startDate":"2016-06-02",
                "endDate":"2016-06-04",
                "t0":7,
                "t1":6,
                "t2":1,
                "t3":4,
                "ri":2,
                "rc":9,
                "demand":5,
                "description":"MEASURING_ERROR",
        "state": "Geçerli."
      }
    ]
  }
}

2.4. How to cancel active additional consumption?

Service parameter details can be accessed from here.

Example XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<additionalAccrualCancelRequest>
        <header>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </header>
        <header>
                <key>application</key>
                <value>gopweb</value>
        </header>
        <header>
                <key>clientIp</key>
                <value>127001</value>
        </header>
        <body>
                <additionalAccrualIds>58372</additionalAccrualIds>
                <additionalAccrualIds>58563</additionalAccrualIds>
        </body>
</additionalAccrualCancelRequest>
Example XML Response
<?xml version="1.0" encoding="UTF-8" ?>
<indexMeteringCancelResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS</resultType>
        <body>
                <cancelledIndexes>58372</cancelledIndexes>
                <cancelledIndexes>58563</cancelledIndexes>
        </body>
</indexMeteringCancelResponse>
Example Json Request
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "additionalAccrualIds": [58372,58563]
  }
}
Example Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "cancelledAdditionalAccruals": [
      58372,
      58563
    ]
  }
}

3. Paths

3.1. Additional consumption canceling / passivate pickup service

POST /additional-accrual/cancel

3.1.1. Description

Service method that performs the cancellation of the additional consumption data were previously installed

3.1.2. Parameters

Type Name Description Schema Default

Header

ecms-service-ticket
required

ST CMS Service Header

string

Body

body
optional

AdditionalAccrualCancelRequest

3.1.3. Responses

HTTP Code Description Schema

200

successful operation

AdditionalAccrualCancelResponse

3.1.4. Produces

  • application/json

  • application/xml

3.1.5. Tags

  • additional-accrual

3.2. Additional consumption data discovery service

POST /additional-accrual/find

3.2.1. Description

Service method that previously saved data with additional consumption index ID information

3.2.2. Parameters

Type Name Description Schema Default

Header

ecms-service-ticket
required

ST CMS Service Header

string

Body

body
optional

AdditionalAccrualFindRequest

3.2.3. Responses

HTTP Code Description Schema

200

successful operation

AdditionalAccrualFindResponse

3.2.4. Produces

  • application/json

  • application/xml

3.2.5. Tags

  • additional-accrual

3.3. Additional consumption saving service

POST /additional-accrual/save

3.3.1. Description

Multiple new service additional consumption methods used to carry out the registration process.

3.3.2. Parameters

Type Name Description Schema Default

Header

ecms-service-ticket
required

ST CMS Service Header

string

Body

body
optional

AdditionalAccrualSaveRequest

3.3.3. Responses

HTTP Code Description Schema

200

successful operation

AdditionalAccrualSaveResponse

3.3.4. Produces

  • application/json

  • application/xml

3.3.5. Tags

  • additional-accrual

3.4. Additional consumption recording data search service

POST /additional-accrual/search

3.4.1. Description

Service method that performs the search in installed additional consumption data

3.4.2. Parameters

Type Name Description Schema Default

Header

ecms-service-ticket
required

ST CMS Service Header

string

Body

body
optional

AdditionalAccrualSearchRequest

3.4.3. Responses

HTTP Code Description Schema

200

successful operation

AdditionalAccrualSearchResponse

3.4.4. Produces

  • application/json

  • application/xml

3.4.5. Tags

  • additional-accrual

3.5. Cancel Index / passivate pickup service

POST /index-metering/cancel

3.5.1. Description

service method that performs the cancellation of the previously loaded index data

3.5.2. Parameters

Type Name Description Schema Default

Header

ecms-service-ticket
required

ST CMS Service Header

string

Body

body
optional

IndexMeteringCancelRequest

3.5.3. Responses

HTTP Code Description Schema

200

successful operation

IndexMeteringCancelResponse

3.5.4. Produces

  • application/json

  • application/xml

3.5.5. Tags

  • index-metering

3.6. Index data discovery service

POST /index-metering/find

3.6.1. Description

service method that has already been stored with the index data index ID information

3.6.2. Parameters

Type Name Description Schema Default

Header

ecms-service-ticket
required

ST CMS Service Header

string

Body

body
optional

IndexMeteringFindRequest

3.6.3. Responses

HTTP Code Description Schema

200

successful operation

IndexMeteringFindResponse

3.6.4. Produces

  • application/json

  • application/xml

3.6.5. Tags

  • index-metering

3.7. Index Metering Service

POST /index-metering/save

3.7.1. Description

method used to perform the service registration process multiple new index.

3.7.2. Parameters

Type Name Description Schema Default

Header

ecms-service-ticket
required

ST CMS Service Header

string

Body

body
required

Index loading request

IndexMeteringSaveRequest

3.7.3. Responses

HTTP Code Description Schema

200

successful operation

IndexMeteringSaveResponse

3.7.4. Produces

  • application/json

  • application/xml

3.7.5. Tags

  • index-metering

3.8. Index metering data search service

POST /index-metering/search

3.8.1. Description

service method that performs the search in the index data loaded

3.8.2. Parameters

Type Name Description Schema Default

Header

ecms-service-ticket
required

ST CMS Service Header

string

Body

body
optional

IndexMeteringSearchRequest

3.8.3. Responses

HTTP Code Description Schema

200

successful operation

IndexMeteringSearchResponse

3.8.4. Produces

  • application/json

  • application/xml

3.8.5. Tags

  • index-metering

4. Definitions

4.1. AdditionalAccrualCancelRequest

Additional consumption data revocation request

Name Description Schema

body
required

Additional consumption data content of the request for cancellation

AdditionalAccrualCancelRequestBody

header
optional

the amount of the request header information.

< Header > array

4.2. AdditionalAccrualCancelRequestBody

Additional consumption data content of the request for cancellation

Name Description Schema

additionalAccrualIds
required

ID information of the requested additional consumption data to be canceled

< integer(int64) > array

4.3. AdditionalAccrualCancelResponse

Additional consumption data, to cancel the answer

Name Description Schema

body
optional

The contents of the additional data in response consumption cancellation

AdditionalAccrualCancelResponseBody

resultCode
required

0 error code includes successful in other cases.
Example : "0"

string

resultDescription
required

It includes a description of the error OK successful cases in other cases
Example : "OK"

string

resultType
required

SUCCESS Successful request, BUSINESSERR if plugged into a business rule, SystemError returns if you encounter a system failure.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.4. AdditionalAccrualCancelResponseBody

The contents of the additional data in response consumption cancellation

Name Description Schema

cancelledAdditionalAccruals
optional

ID information of additional consumption data canceled

< integer(int64) > array

4.5. AdditionalAccrualFindRequest

Additional consumption data discovery request

Name Description Schema

body
required

Additional consumption data discovery request content

AdditionalAccrualFindRequestBody

header
optional

the amount of the request header information.

< Header > array

4.6. AdditionalAccrualFindRequestBody

Additional consumption data discovery request content

Name Description Schema

additionalAccrualIds
required

ID list of requested no additional consumption

< integer(int64) > array

4.7. AdditionalAccrualFindResponse

Additional consumption data discovery process is the answer

Name Description Schema

body
optional

Answer contents of additional consumption data discovery process

AdditionalAccrualFindResponseBody

resultCode
required

0 error code includes successful in other cases.
Example : "0"

string

resultDescription
required

It includes a description of the error OK successful cases in other cases
Example : "OK"

string

resultType
required

SUCCESS Successful request, BUSINESSERR if plugged into a business rule, SystemError returns if you encounter a system failure.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.8. AdditionalAccrualFindResponseBody

Answer contents of additional consumption data discovery process

Name Description Schema

additionalAccruals
optional

Found additional consumption data

< AdditionalAccrualQueryResponseModel > array

4.9. AdditionalAccrualQueryResponseModel

Additional consumption measurement model search results

Name Description Schema

additionalAccrualId
optional

Additional consumption registration ID value

integer(int64)

demand
optional

Additional consumer demand value

number

description
optional

Additional consumption description (Mandatory when Additional consumption reason is OTHER)

string

editingDate
optional

Additional consumption Editing Date

string(date-time)

endDate
optional

Additional consumer end date

string(date-time)

lineLoss
optional

Line loss information(0: NO 1: YES)

integer(int32)

measuringOrgId
optional

Meter reading organization information

integer(int64)

meteringPointEic
optional

Measuring point EIC

string

meteringPointId
optional

Measuring point ID

integer(int64)

period
optional

Measurements were periodically

string(date-time)

rc
optional

Additional consumption RC value

number

reason
optional

Additional consumption reason MEASURING_CIRCUIT_FAILURE(Measuring circuit failure) METER_RECORDING_ERROR(Meter recording error) METER_MEASURING_FAULT(Meter fault) WRONG_FACTOR_RECORD(Wrong factor record) METER_DIGIT_FAULT(Meter digit fault) PLANT_CONSUMPTION_WITHOUT_MEASURING_CIRCUIT(Consumption without measuring system) MEASURING_ERROR(Measuring error) OTHER(Other reasons)

enum (MEASURING_CIRCUIT_FAILURE, METER_RECORDING_ERROR, METER_MEASURING_FAULT, WRONG_FACTOR_RECORD, METER_DIGIT_FAULT, PLANT_CONSUMPTION_WITHOUT_MEASURING_CIRCUIT, MEASURING_ERROR, OTHER)

recordDate
optional

Additional accrual recording time

string(date-time)

ri
optional

Additional consumption RI values

number

startDate
optional

Additional consumption since

string(date-time)

state
optional

Recording information

string

status
optional

Additional consumption status information

enum (ACTIVE, PASSIVE)

supplierOrgId
optional

Supplier institutions ID information (only for EPİAŞ users)

integer(int64)

t0
optional

Additional consumption value T0

number

t1
optional

Additional consumption value T1

number

t2
optional

Additional consumption value T2

number

t3
optional

Additional consumption value T3

number

transformerLoss
optional

Transformer loss information (0: NO 1: YES)

integer(int32)

4.10. AdditionalAccrualRequestModel

Additional consumption data download request model

Name Description Schema

demand
optional

Additional consumer demand value

number

description
optional

Additional consumption description (Mandatory when Additional consumption reason is OTHER)

string

endDate
required

Additional consumer end date

string(date-time)

meteringPointEic
required

Measuring point EIC

string

meteringPointId
required

Measuring point ID

integer(int64)

period
required

Measurements were periodically

string(date-time)

rc
optional

Additional consumption RC value

number

reason
required

Additional consumption reason MEASURING_CIRCUIT_FAILURE(Measuring circuit failure) METER_RECORDING_ERROR(Meter recording error) METER_MEASURING_FAULT(Meter fault) WRONG_FACTOR_RECORD(Wrong factor record) METER_DIGIT_FAULT(Meter digit fault) PLANT_CONSUMPTION_WITHOUT_MEASURING_CIRCUIT(Consumption without measuring system) MEASURING_ERROR(Measuring error) OTHER(Other reasons)

enum (MEASURING_CIRCUIT_FAILURE, METER_RECORDING_ERROR, METER_MEASURING_FAULT, WRONG_FACTOR_RECORD, METER_DIGIT_FAULT, PLANT_CONSUMPTION_WITHOUT_MEASURING_CIRCUIT, MEASURING_ERROR, OTHER)

ri
optional

Additional consumption RI values

number

startDate
required

Additional consumption since

string(date-time)

t0
optional

Additional consumption value T0

number

t1
optional

Additional consumption value T1

number

t2
optional

Additional consumption value T2

number

t3
optional

Additional consumption value T3

number

4.11. AdditionalAccrualResponseModel

Additional consumption data model results

Name Description Schema

additionalAccrualId
optional

Additional consumption registration ID value

integer(int64)

demand
optional

Additional consumer demand value

number

description
optional

Additional consumption description (Mandatory when Additional consumption reason is OTHER)

string

editingDate
optional

Additional consumption Editing Date

string(date-time)

endDate
optional

Additional consumer end date

string(date-time)

measuringOrgId
optional

Meter reading organization information

integer(int64)

meteringPointEic
optional

Measuring point EIC

string

meteringPointId
optional

Measuring point ID

integer(int64)

period
optional

Measurements were periodically

string(date-time)

rc
optional

Additional consumption RC value

number

reason
optional

Additional consumption reason MEASURING_CIRCUIT_FAILURE(Measuring circuit failure) METER_RECORDING_ERROR(Meter recording error) METER_MEASURING_FAULT(Meter fault) WRONG_FACTOR_RECORD(Wrong factor record) METER_DIGIT_FAULT(Meter digit fault) PLANT_CONSUMPTION_WITHOUT_MEASURING_CIRCUIT(Consumption without measuring system) MEASURING_ERROR(Measuring error) OTHER(Other reasons)

enum (MEASURING_CIRCUIT_FAILURE, METER_RECORDING_ERROR, METER_MEASURING_FAULT, WRONG_FACTOR_RECORD, METER_DIGIT_FAULT, PLANT_CONSUMPTION_WITHOUT_MEASURING_CIRCUIT, MEASURING_ERROR, OTHER)

recordDate
optional

Additional accrual recording time

string(date-time)

ri
optional

Additional consumption RI values

number

startDate
optional

Additional consumption since

string(date-time)

state
optional

Recording information

string

status
optional

Additional consumption status information

enum (ACTIVE, PASSIVE)

t0
optional

Additional consumption value T0

number

t1
optional

Additional consumption value T1

number

t2
optional

Additional consumption value T2

number

t3
optional

Additional consumption value T3

number

4.12. AdditionalAccrualSaveRequest

Additional consumption upload request

Name Description Schema

body
required

Installation of additional consumption demand content

AdditionalAccrualSaveRequestBody

header
optional

the amount of the request header information.

< Header > array

4.13. AdditionalAccrualSaveRequestBody

Installation of additional consumption demand content

Name Description Schema

additionalAccruals
required

additional consumption data to be loaded

< AdditionalAccrualRequestModel > array

4.14. AdditionalAccrualSaveResponse

Additional consumption installation answer

Name Description Schema

body
required

The content of the additional installation response consumption

AdditionalAccrualSaveResponseBody

resultCode
required

0 error code includes successful in other cases.
Example : "0"

string

resultDescription
required

It includes a description of the error OK successful cases in other cases
Example : "OK"

string

resultType
required

SUCCESS Successful request, BUSINESSERR if plugged into a business rule, SystemError returns if you encounter a system failure.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.15. AdditionalAccrualSaveResponseBody

The content of the additional installation response consumption

Name Description Schema

additionalAccruals
required

Downloaded additional consumer information

< AdditionalAccrualResponseModel > array

4.16. AdditionalAccrualSearchCriterias

Additional consumption data search criteria

Name Description Schema

editingDate
optional

Additional consumption data editing date

string(date-time)

endDate
optional

End date criteria

string(date-time)

measuringOrgId
optional

Meter reading agency ID information criterion (For only suppliers and EPIAS users)

integer(int64)

meteringPointEic
optional

Measuring point EIC criteria

string

meteringPointId
optional

Measuring point ID criteria

integer(int64)

period
optional

Period criteria

string(date-time)

recordDateBegin
optional

Additional consumption data recording date range start

string(date-time)

recordDateEnd
optional

Additional consumption data recording date range end

string(date-time)

startDate
optional

Start date criteria

string(date-time)

status
optional

Additional consumption data by state

enum (ACTIVE, PASSIVE)

supplierOrgId
optional

Supplier institutions ID information criterion (For only EPIAS users)

integer(int64)

4.17. AdditionalAccrualSearchRequest

Additional consumption data search request

Name Description Schema

body
required

Additional consumption data search request content

AdditionalAccrualSearchRequestBody

header
optional

the amount of the request header information.

< Header > array

4.18. AdditionalAccrualSearchRequestBody

Additional consumption data search request content

Name Description Schema

criterias
required

Additional consumption data by the search request information

AdditionalAccrualSearchCriterias

range
optional

It specifies the number of records with the introduction of the desired start and end index numbers.

Range

4.19. AdditionalAccrualSearchResponse

Additional consumption data for search results

Name Description Schema

body
optional

Additional consumption data search results content

AdditionalAccrualSearchResponseBody

resultCode
required

0 error code includes successful in other cases.
Example : "0"

string

resultDescription
required

It includes a description of the error OK successful cases in other cases
Example : "OK"

string

resultType
required

SUCCESS Successful request, BUSINESSERR if plugged into a business rule, SystemError returns if you encounter a system failure.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.20. AdditionalAccrualSearchResponseBody

Additional consumption data search results content

Name Description Schema

additionalAccruals
optional

Additional consumption data records from the search result list of additional consumption

< AdditionalAccrualQueryResponseModel > array

queryInformation
optional

and the records of how many records he returned in service response which contains the information that is in the range intervals.

QueryInformation

4.21. Header

the amount of the request header information.

Name Description Schema

key
optional

Header information holds the key.
Example : "transactionId"

string

value
optional

Keeps Header value information.
Example : "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"

string

4.22. IndexMeteringCancelRequest

Index data revocation request

Name Description Schema

body
required

Index gives the contents of the request for cancellation

IndexMeteringCancelRequestBody

header
optional

the amount of the request header information.

< Header > array

4.23. IndexMeteringCancelRequestBody

Index gives the contents of the request for cancellation

Name Description Schema

indexIds
required

ID information of the requested index data to be canceled

< integer(int64) > array

4.24. IndexMeteringCancelResponse

Index data, to cancel the answer

Name Description Schema

body
optional

The contents of index data to cancel reply

IndexMeteringCancelResponseBody

resultCode
required

0 error code includes successful in other cases.
Example : "0"

string

resultDescription
required

It includes a description of the error OK successful cases in other cases
Example : "OK"

string

resultType
required

SUCCESS Successful request, BUSINESSERR if plugged into a business rule, SystemError returns if you encounter a system failure.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.25. IndexMeteringCancelResponseBody

The contents of index data to cancel reply

Name Description Schema

cancelledIndexes
optional

ID information of canceled index data

< integer(int64) > array

4.26. IndexMeteringFindRequest

Index data discovery request

Name Description Schema

body
required

Index data discovery request content

IndexMeteringFindRequestBody

header
optional

the amount of the request header information.

< Header > array

4.27. IndexMeteringFindRequestBody

Index data discovery request content

Name Description Schema

indexIds
required

None of the ID list of the desired index

< integer(int64) > array

4.28. IndexMeteringFindResponse

Index data is the process of finding the answer

Name Description Schema

body
optional

The contents of the response data discovery process Index

IndexMeteringFindResponseBody

resultCode
required

0 error code includes successful in other cases.
Example : "0"

string

resultDescription
required

It includes a description of the error OK successful cases in other cases
Example : "OK"

string

resultType
required

SUCCESS Successful request, BUSINESSERR if plugged into a business rule, SystemError returns if you encounter a system failure.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.29. IndexMeteringFindResponseBody

The contents of the response data discovery process Index

Name Description Schema

indexes
optional

Found index data

< IndexMeteringQueryResponseModel > array

4.30. IndexMeteringQueryResponseModel

Index measurement model search results

Name Description Schema

description
optional

Measurement description

string

digitCount
optional

Digit Count

integer(int64)

editingDate
optional

Index editing time

string(date-time)

factor
optional

Multiplier

number

firstLoadType
optional

The first type of installation. AUTOMATED (AMR) manually (read field) predicted (Prediction)

enum (AUTOMATED, MANUALLY, PREDICTED)

firstMeasureDate
optional

The first reading of the history

string(date-time)

firstMeasureType
optional

First reading type. PERIODIC (Periodical Reading) Subscription (Subscription Reading) CLOSING_RELEAS (Closing-drain Reading) METER_CHANGING_DISASSEMBLY (Counter Exchange-removal) METER_CHANGING_ASSEMBLY (Meter Replacement-Battery) DEBT_LEAK_TURN_OFF (Debt / Illegal Cutting Reading) DEBT_LEAK_TURN_O’s (Debt / Leak On Reading) INTERIM (Dec Reading) SUPPLIER_CHANGE (Supplier Changing)

enum (PERIODIC, SUBSCRIPTION, CLOSING_RELEASE, METER_CHANGING_DISASSEMBLY, METER_CHANGING_ASSEMBLY, DEBT_LEAK_TURN_OFF, DEBT_LEAK_TURN_ON, INTERIM, SUPPLIER_CHANGE)

firstT0
optional

The first index value T0

number

firstT1
optional

The first index value T1

number

firstT2
optional

The first index value T2

number

firstT3
optional

The first index value T3

number

indexId
optional

Index ID number

integer(int64)

lastLoadType
optional

Last installation type. AUTOMATED (AMR) manually (read field) predicted (Prediction)

enum (AUTOMATED, MANUALLY, PREDICTED)

lastMeasureDate
optional

Recently read

string(date-time)

lastMeasureType
optional

Last reading type. PERIODIC (Periodical Reading) Subscription (Subscription Reading) CLOSING_RELEAS (Closing-drain Reading) METER_CHANGING_DISASSEMBLY (Counter Exchange-removal) DEBT_LEAK_TURN_OFF (Debt / Illegal Cutting Reading) INTERIM (mid Reading) SUPPLIER_CHANGE (Supplier Changing) should not be sent to * METER_CHANGING_ASSEMBLY and DEBT_LEAK_TURN_O in. *

enum (PERIODIC, SUBSCRIPTION, CLOSING_RELEASE, METER_CHANGING_DISASSEMBLY, METER_CHANGING_ASSEMBLY, DEBT_LEAK_TURN_OFF, DEBT_LEAK_TURN_ON, INTERIM, SUPPLIER_CHANGE)

lastT0
optional

Last index value T0

number

lastT1
optional

Last index value T1

number

lastT2
optional

Last index value T2

number

lastT3
optional

Last T3 index value

number

lineLoss
optional

Line loss information (0: NO 1: YES)

integer(int32)

measuringOrgId
optional

Meter reading organization information

integer(int64)

meterBrand
optional

Counter model

string

meterSerialNumber
optional

Meter serial number

string

meterType
optional

Counter type. MECHANICAL (Mechanical) ELECTRONIC (Electronics)

enum (MECHANICAL, ELECTRONIC)

meteringPointEic
optional

Measuring point EIC

string

meteringPointId
optional

Measuring point ID

integer(int64)

period
optional

Measurements were periodically

string(date-time)

periodDescription
required

Period Measurement Description

string

powerType
optional

Type of energy. ACTIVE (Active) INDUCTIVE (inductive) capacitive (capacitive) DEMAND (Demand)

enum (ACTIVE, INDUCTIVE, CAPACITIVE, DEMAND)

recordDate
optional

Index recording time

string(date-time)

state
optional

Recording information

string

status
optional

Measurement of stateful Index

enum (ACTIVE, PASSIVE, OLD_VERSION)

supplierOrgId
optional

Supplier institutions ID information (only for EPİAŞ users)

integer(int64)

transformerLoss
optional

Transformer loss information (0: NO 1: YES)

integer(int32)

4.31. IndexMeteringRequestModel

Index measurement data download request model

Name Description Schema

description
optional

Measurement description

string

digitCount
optional

Digit Count

integer(int64)

factor
required

Multiplier

number

firstLoadType
required

The first type of installation. AUTOMATED (AMR) manually (read field) predicted (Prediction)

enum (AUTOMATED, MANUALLY, PREDICTED)

firstMeasureDate
required

The first reading of the history

string(date-time)

firstMeasureType
required

First reading type. PERIODIC (Periodical Reading) Subscription (Subscription Reading) CLOSING_RELEAS (Closing-drain Reading) METER_CHANGING_DISASSEMBLY (Counter Exchange-removal) METER_CHANGING_ASSEMBLY (Meter Replacement-Battery) DEBT_LEAK_TURN_OFF (Debt / Illegal Cutting Reading) DEBT_LEAK_TURN_O’s (Debt / Leak On Reading) INTERIM (Dec Reading) SUPPLIER_CHANGE (Supplier Changing)

enum (PERIODIC, SUBSCRIPTION, CLOSING_RELEASE, METER_CHANGING_DISASSEMBLY, METER_CHANGING_ASSEMBLY, DEBT_LEAK_TURN_OFF, DEBT_LEAK_TURN_ON, INTERIM, SUPPLIER_CHANGE)

firstT0
optional

The first index value T0

number

firstT1
optional

The first index value T1

number

firstT2
optional

The first index value T2

number

firstT3
optional

The first index value T3

number

lastLoadType
required

Last installation type. AUTOMATED (AMR) manually (read field) predicted (Prediction)

enum (AUTOMATED, MANUALLY, PREDICTED)

lastMeasureDate
required

Recently read

string(date-time)

lastMeasureType
required

Last reading type. PERIODIC (Periodical Reading) Subscription (Subscription Reading) CLOSING_RELEAS (Closing-drain Reading) METER_CHANGING_DISASSEMBLY (Counter Exchange-removal) DEBT_LEAK_TURN_OFF (Debt / Illegal Cutting Reading) INTERIM (mid Reading) SUPPLIER_CHANGE (Supplier Changing) should not be sent to * METER_CHANGING_ASSEMBLY and DEBT_LEAK_TURN_O in. *

enum (PERIODIC, SUBSCRIPTION, CLOSING_RELEASE, METER_CHANGING_DISASSEMBLY, METER_CHANGING_ASSEMBLY, DEBT_LEAK_TURN_OFF, DEBT_LEAK_TURN_ON, INTERIM, SUPPLIER_CHANGE)

lastT0
optional

Last index value T0

number

lastT1
optional

Last index value T1

number

lastT2
optional

Last index value T2

number

lastT3
optional

Last T3 index value

number

meterBrand
required

Counter model

string

meterSerialNumber
required

Meter serial number

string

meterType
required

Counter type. MECHANICAL (Mechanical) ELECTRONIC (Electronics)

enum (MECHANICAL, ELECTRONIC)

meteringPointEic
required

Measuring point EIC

string

meteringPointId
required

Measuring point ID

integer(int64)

period
required

Measurements were periodically

string(date-time)

periodDescription
required

Period Measurement Description

string

powerType
required

Index type. ACTIVE (Active) INDUCTIVE (inductive) capacitive (capacitive) DEMAND (Demand)

enum (ACTIVE, INDUCTIVE, CAPACITIVE, DEMAND)

4.32. IndexMeteringResponseModel

Index results measurement data model

Name Description Schema

description
optional

Measurement description

string

digitCount
optional

Digit Count

integer(int64)

editingDate
optional

Index editing time

string(date-time)

factor
optional

Multiplier

number

firstLoadType
optional

The first type of installation. AUTOMATED (AMR) manually (read field) predicted (Prediction)

enum (AUTOMATED, MANUALLY, PREDICTED)

firstMeasureDate
optional

The first reading of the history

string(date-time)

firstMeasureType
optional

First reading type. PERIODIC (Periodical Reading) Subscription (Subscription Reading) CLOSING_RELEAS (Closing-drain Reading) METER_CHANGING_DISASSEMBLY (Counter Exchange-removal) METER_CHANGING_ASSEMBLY (Meter Replacement-Battery) DEBT_LEAK_TURN_OFF (Debt / Illegal Cutting Reading) DEBT_LEAK_TURN_O’s (Debt / Leak On Reading) INTERIM (Dec Reading) SUPPLIER_CHANGE (Supplier Changing)

enum (PERIODIC, SUBSCRIPTION, CLOSING_RELEASE, METER_CHANGING_DISASSEMBLY, METER_CHANGING_ASSEMBLY, DEBT_LEAK_TURN_OFF, DEBT_LEAK_TURN_ON, INTERIM, SUPPLIER_CHANGE)

firstT0
optional

The first index value T0

number

firstT1
optional

The first index value T1

number

firstT2
optional

The first index value T2

number

firstT3
optional

The first index value T3

number

indexId
optional

Index ID number

integer(int64)

lastLoadType
optional

Last installation type. AUTOMATED (AMR) manually (read field) predicted (Prediction)

enum (AUTOMATED, MANUALLY, PREDICTED)

lastMeasureDate
optional

Recently read

string(date-time)

lastMeasureType
optional

Last reading type. PERIODIC (Periodical Reading) Subscription (Subscription Reading) CLOSING_RELEAS (Closing-drain Reading) METER_CHANGING_DISASSEMBLY (Counter Exchange-removal) DEBT_LEAK_TURN_OFF (Debt / Illegal Cutting Reading) INTERIM (mid Reading) SUPPLIER_CHANGE (Supplier Changing) should not be sent to * METER_CHANGING_ASSEMBLY and DEBT_LEAK_TURN_O in. *

enum (PERIODIC, SUBSCRIPTION, CLOSING_RELEASE, METER_CHANGING_DISASSEMBLY, METER_CHANGING_ASSEMBLY, DEBT_LEAK_TURN_OFF, DEBT_LEAK_TURN_ON, INTERIM, SUPPLIER_CHANGE)

lastT0
optional

Last index value T0

number

lastT1
optional

Last index value T1

number

lastT2
optional

Last index value T2

number

lastT3
optional

Last T3 index value

number

measuringOrgId
optional

Meter reading organization information

integer(int64)

meterBrand
optional

Counter model

string

meterSerialNumber
optional

Meter serial number

string

meterType
optional

Counter type. MECHANICAL (Mechanical) ELECTRONIC (Electronics)

enum (MECHANICAL, ELECTRONIC)

meteringPointEic
optional

Measuring point EIC

string

meteringPointId
optional

Measuring point ID

integer(int64)

period
optional

Measurements were periodically

string(date-time)

periodDescription
required

Period Measurement Description

string

powerType
optional

Type of energy. ACTIVE (Active) INDUCTIVE (inductive) capacitive (capacitive) DEMAND (Demand)

enum (ACTIVE, INDUCTIVE, CAPACITIVE, DEMAND)

recordDate
optional

Index recording time

string(date-time)

state
optional

Recording information

string

status
optional

Measurement of stateful Index

enum (ACTIVE, PASSIVE, OLD_VERSION)

4.33. IndexMeteringSaveRequest

Index loading request

Name Description Schema

body
required

Index content upload request

IndexMeteringSaveRequestBody

header
optional

the amount of the request header information.

< Header > array

4.34. IndexMeteringSaveRequestBody

Index content upload request

Name Description Schema

indexes
required

indices will be loading

< IndexMeteringRequestModel > array

4.35. IndexMeteringSaveResponse

Installation Index answer

Name Description Schema

body
required

answer contents of the installation process Index

IndexMeteringSaveResponseBody

resultCode
required

0 error code includes successful in other cases.
Example : "0"

string

resultDescription
required

It includes a description of the error OK successful cases in other cases
Example : "OK"

string

resultType
required

SUCCESS Successful request, BUSINESSERR if plugged into a business rule, SystemError returns if you encounter a system failure.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.36. IndexMeteringSaveResponseBody

answer contents of the installation process Index

Name Description Schema

indexes
optional

Downloaded information index

< IndexMeteringResponseModel > array

4.37. IndexMeteringSearchCriterias

data search index

Name Description Schema

editingDate
optional

Index data editing date

string(date-time)

firstMeasureDate
optional

The first measurement point criterion

string(date-time)

indexId
optional

Index ID kriteri

integer(int64)

lastMeasureDate
optional

Last measurement point by

string(date-time)

measuringOrgId
optional

Meter reading agency ID information criterion (For only suppliers and EPIAS users)

integer(int64)

meterSerialNumber
optional

Counter serial number criterion

string

meteringPointEic
optional

Measurement point EIC criterion

string

meteringPointId
optional

Measurement point ID criterion

integer(int64)

period
optional

Period criteria

string(date-time)

periodInterval
optional

Period interval criterion. It allows data to be taken up to one year before the given date.

string(date-time)

powerType
optional

Index data index type criterion

enum (ACTIVE, INDUCTIVE, CAPACITIVE, DEMAND)

recordDateBegin
optional

Index data recording date range start

string(date-time)

recordDateEnd
optional

Index data recording date range end

string(date-time)

status
optional

Index data availability criteria

enum (ACTIVE, PASSIVE, OLD_VERSION)

supplierOrgId
optional

Supplier institutions ID information criterion (For only EPIAS users)

integer(int64)

4.38. IndexMeteringSearchRequest

Index data search request

Name Description Schema

body
required

Index search request data content

IndexMeteringSearchRequestBody

header
optional

the amount of the request header information.

< Header > array

4.39. IndexMeteringSearchRequestBody

Index search request data content

Name Description Schema

criterias
required

Index data search request information by

IndexMeteringSearchCriterias

range
optional

It specifies the number of records with the introduction of the desired start and end index numbers.

Range

4.40. IndexMeteringSearchResponse

Index data for search results

Name Description Schema

body
optional

Index data in search results for content

IndexMeteringSearchResponseBody

resultCode
required

0 error code includes successful in other cases.
Example : "0"

string

resultDescription
required

It includes a description of the error OK successful cases in other cases
Example : "OK"

string

resultType
required

SUCCESS Successful request, BUSINESSERR if plugged into a business rule, SystemError returns if you encounter a system failure.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.41. IndexMeteringSearchResponseBody

Index data in search results for content

Name Description Schema

indexes
optional

index records list data from the index search results

< IndexMeteringQueryResponseModel > array

queryInformation
optional

and the records of how many records he returned in service response which contains the information that is in the range intervals.

QueryInformation

4.42. QueryInformation

and the records of how many records he returned in service response which contains the information that is in the range intervals.

Name Description Schema

begin
optional

the amount of value Initial range.
Example : 1

integer(int32)

count
optional

The total amount of records information.
Example : 4444

integer(int32)

end
optional

End the amount of range values.
Example : 10

integer(int32)

4.43. Range

It specifies the number of records with the introduction of the desired start and end index numbers.

Name Description Schema

begin
optional

the amount of value Initial range.
Example : 1

integer(int32)

end
optional

End the amount of range values.
Example : 10

integer(int32)