Genel Bakış

Versiyon bilgisi

Versiyon : v1

URI şeması

Sunucu : tys.epias.com.tr
Kök Dizin : /ecms-index-metering-data/rest
Şemalar : HTTPS

Etiketler

  • additional-accrual

  • index-metering

Döküman Hakkında

Bu dökümanda Ölçüm Noktası Servislerinin tanımları ve bu servislerin nasıl çağrılacağı anlatılmaktadır.

Döküman her sürümde güncellendiğinden test ve gerçek ortam içerisindeki servisler farklılık gösterebilir. Sürüm notlarını takip ediniz.

Değişiklikler

1.0.0 Servis tanımları

Uygulama Hakkında

Bu uygulama REST servisleri üzerine kuruludur. JSON ve XML isteklerini kabul eder ve gelen isteğe göre JSON yada XML cevap döner.

Uygulamayı çağırabilmek için DGPYS de kayıtlı bir kullanıcınız olmalı ve bu kullanıcının ilgili servisleri çağırabilmek için yeterli yetkisi olmalıdır. Uygulamaya gelen tüm istekler Merkezi Yetkilendirme Sunucusu’ndan (gerçek ortam için https://cas.epias.com.tr test ortamı için https://testcas.epias.com.tr) etiket alınarak gönderilmelidir.

İstemci Oluşturmak

Servis dökümantasyonu Swagger ile hazırlanmıştır. Test ortamı için https://testtys.epias.com.tr/ecms-index-metering-data/test/swagger.json gerçek ortam için https://tys.epias.com.tr/ecms-index-metering-data/test/swagger.json dosyasını kullanarak https://generator.swagger.io adresinden kullandığınız dile uygun istemci kodlarını oluşturabilirsiniz.

Yardım ve Destek

Uygulama için gorusleriniz.st@epias.com.tr adresine görüş, öneri ve yardım isteklerinizi gönderebilirsiniz.

Uygulama Servis Çağrımı

TGT (Ticket Granting Ticket) kullanıcının oturumunu kontrol eder. TGT Servisinden alacağınız değer 45 dakika boyunca kullanmasanız bile aktiftir. TGT değerini her kullanışınızda 45 dakikalık süre tekrar başlar.

TGT ile servisi çağırmanız mümkün değildir. Her servis çağrımında TGT üzerinden ST (Service Ticket) almanız gerekir. TGT tekrar kullanılabilen bir değerdir. Her istek için TGT almanıza gerek yoktur. Her istek için TGT almanız halinde CAS (Merkezi Yetkilendirme Sunucusu) tarafından bloke edilebilirsiniz.

Ticket Granting Ticket (TGT) Oluşturma

TGT oluşturmak için gerçek ortam https://cas.epias.com.tr/cas/v1/tickets?format=text yada test ortamı https://testcas.epias.com.tr/cas/v1/tickets?format=text adresine aşağıdaki değerleri POST metodu ile göndermeniz gerekmektedir.

Gönderilen HTTP isteğinin header kısmında Content-Type karşılığında ise application/x-www-form-urlencoded yazmalıdır.

parametre değer

username

DGPYS Kullanıcı Adı

password

DGPYS Şifresi
örnek http isteği
POST /cas/v1/tickets HTTP/1.1
Host: cas.epias.com.tr
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded

username=PK195&password=PK195

Servisten HTTP 201 cevabını beklemelisiniz. Sonuç olarak aşağıdaki gibi bir örnek dönecektir.

örnek cevap
TGT-237-U0TU0jUHLyOEIrdoDBEEf3AdRFAXGLifK2ITn4LoY3HfhstGtx-cas02.epias.com.tr

Service Ticket (ST) Oluşturma

ST oluşturmak için önce TGT alınmalıdır. TGT alındıktan sonra şu şekilde bir istek adresi oluşturulur. Gerçek ortam için https://cas.epias.com.tr/cas/v1/tickets/{TGT} test ortamı için https://testcas.epias.com.tr/cas/v1/tickets/{TGT}

Bir servis için alınan ST başka bir servis için kullanılamaz.
ST nin geçerlilik süresi 30 saniyedir.
Uygulamanın servis adı gerçek ortam için https://tys.epias.com.tr test ortamı için https://testtys.epias.com.tr
örnek
https://cas.epias.com.tr/cas/v1/tickets/TGT-229-2hmcHafszagAAxtCh017nax1en3U9TouWeGvIrq9KbSbeKE9Zk-cas02.epias.com.tr

Bu adrese aşağıdaki parametreler POST metodu ile gönderilir.

parametre değer

service

test ortamı için https://testtys.epias.com.tr gerçek ortam için https://tys.epias.com.tr

Sonuç olarak aşağıdaki cevap döner. Bu servisten HTTP 200 döndüğünde ST yi başarılı olarak almış olursunuz.

örnek
ST-29962-hSwyzWCP0xC0eRi0bmna-cas01.epias.com.tr

Uygulama Örnek Mesaj Yapısı

Servislerinin standart bir mesaj yapısı bulunmaktadır. Gönderdiğiniz tüm isteklerde bu formata uygun veri göndermelisiniz.

Öncelikle her isteğin HTTP header alanına aşağıdaki değerleri eklemelisiniz.

parametre değer

ecms-service-ticket

Service Ticket (ST) Örneğin : ST-30247-uNWazHn52sKZU71v5Ar4-cas02.epias.com.tr

Accept

application/json veya application/xml

Content-Type

application/json veya application/xml

Accept-Language

tr-tr veya en-us (ingilizce henüz test aşamasındadır)

Servis mesajları iki bölümden oluşur.

Birinci bölüm header olarak kullanılan ve isteği, gönderdiğiniz servisten bağımsız olarak isteği tanımlayan mesaj alanıdır. header alanında aşağıdaki anahtarlar bulunmalıdır.

parametre değer açıklama

transactionId

isteği tanımlayan benzersiz anahtar (Universal Unique Identifier)

isteğiniz ile ilgili sorularınızda bu id değerini sizden isteyeceğiz

application

servisi çağırırken kullanmış olduğunuz uygulamanın adı

İkinci bölüm ise çağırdığınız servise has parametreleri içeren body alanıdır. Tüm servisler için farklılık gösterebilir.

Aşağıdaki örnekte teslim gününün doğru olup olmadığını kontrol eden bir mesaj bulunmaktadır.

header alanını anahtar (key) ve değer (value) şeklinde gönderilmelidir.
Servise gelen ve giden tüm mesajlardaki tarih alanları ISO-8601 formatındadır. Format yyyy-MM-dd’T’HH:mm:ss.SSSZ şeklinde olmalıdır. Timezone değeri Yaz Saati Uygulamasında için +03:00 Kış Saatin Uygulamasında +02:00 olarak değişmektedir. O yüzden dökümanın içerisinde verilen örnek JSON dosyalarındaki tarih alanlarına dikkat ediniz. Örnek bir zaman değeri şu şekildedir. 2016-03-25T00:00:00.000+0300
Örnek ISO8601 Parser 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);
    }
}
Örnek HTTP Mesajı
POST /ecms-unregistered-metering-point/rest/ump/list HTTP/1.1
Host: testtysapi.epias.com.tr
Accept: application/json
Content-Type: application/json
gop-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"]
   }
}
Örnek JSON Mesajı
{
   "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
         }
      ]
   }
}

Gönderilen tüm isteklere dönen cevaplar da iki bölümden oluşur. Birinci bölüm isteğin başarılı olup olmadığını dönen result ile başlayan değerler. İkinci bölüm ise body alanında sonucu dönen kısım.

Her sonuç mesajında aşağıdaki alanlar sabit olarak bulunur.

parametre tip değer açıklama

resultCode

string

"0" başarılı diğer hallerde hatakodu içerir

aldığınız hatalar ile ilgili bilgi almak isterseniz bu alanı sizden isteyeceğiz.

resultDescription

string

başarılı durumda "OK" diğer hallerde hatanın açıklamasını içerir

aldığınız hatalar ile ilgili bilgi almak isterseniz bu alanı sizden isteyeceğiz. SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR

resultType

string

başarılı isteklerde SUCCESS , bir iş kuralına takıldıysanız BUSINESSERROR , bir sistem hatası ile karşılaşırsanız SYSTEMERROR, yetkilendirme ile ilgili hata alırsanız SECURITYERROR
BUSINESSERROR : Göndermiş olduğunuz istek ile ilgili bir sorun olduğunu belirtir. İsteğinizi gözden geçirmelisiniz. SYSTEMERROR : Sistemde bir hata olduğunu belirtir. Bizimle irtibata geçmelisiniz.
Örnek Başarılı JSON Cevap Mesajı
{"resultCode":"0","resultDescription":"OK","body":true,"resultType":"SUCCESS"}

Postman Kullanımı

https://www.getpostman.com linkinden yüklenebilecek Postman ile TYS Rest Servislerine erişim yapabilmeniz için hazırlanmış kolleksiyonlara aşağıdaki linkten erişebilirsiniz: Uygulama https://www.getpostman.com/collections/fbd93e82583e06365daf ve CAS https://www.getpostman.com/collections/b8972a6217c969728613

Postman kolleksiyonlarını içe aktardıktan sonra, postman için hazırlanmış olan çevre değişkenlerini de içe aktarmanız gerekmektedir. Json şeklinde hazırlanan bu ortam şu şekildedir: Buradaki adresleri test ortamını kullancak iseniz değiştirmelisiniz. Aşağıdaki adresler gerçek ortam için hazırlanmıştır.

Postman parametreleri
{
  "id": "eb07c188-7c5b-9217-683d-fa9a0ef49551",
  "name": "TYS-Env",
  "values": [
    {
      "key": "base-url",
      "value": "{app-production}",
      "type": "text",
      "enabled": true
    },
    {
      "key": "cas-gt-uri",
      "value": "{cas-production}/cas/v1/tickets?format=text",
      "type": "text",
      "enabled": true
    },
    {
      "key": "cas-st-uri",
      "value": "{cas-production}/cas/v1/tickets/",
      "type": "text",
      "enabled": true
    },
    {
      "key": "cas-st-domain",
      "value": "{app-production}",
      "type": "text",
      "enabled": true
    },
    {
      "key": "service-ticket",
      "value": "ecms-service-ticket",
      "type": "text",
      "enabled": true
    },
    {
      "key": "cas-gt",
      "value": "",
      "type": "text",
      "enabled": true
    },
    {
      "key": "cas-st",
      "value": "",
      "type": "text",
      "enabled": true
    },
    {
      "key": "language",
      "value": "tr-tr",
      "type": "text",
      "enabled": true
    },
    {
      "key": "cmp",
      "value": "ecms-consumption-metering-point/rest",
      "type": "text",
      "enabled": true
    },
    {
      "key": "ecms",
      "value": "ecms-eligible-customer-registration/rest",
      "type": "text",
      "enabled": true
    },
    {
      "key": "imd",
      "value": "ecms-index-metering-data/rest",
      "type": "text",
      "enabled": true
    },
    {
      "key": "ump",
      "value": "ecms-unregistered-metering-point-rest/rest",
      "type": "text",
      "enabled": true
    }
  ],
  "timestamp": 1477037360916,
  "_postman_variable_scope": "environment",
  "_postman_exported_at": "2016-10-21T11:42:24.857Z",
  "_postman_exported_using": "Postman/4.8.0"
}

Belirtilen Json' yüklendikten sonra TYS servislerine erişilirken Postman arayüzünde sağ üst köşede bulunan "Environment" kısmından TYS seçilmelidir.

Granting Ticket almak için, "0-CAS Request/Grating Ticket İsteği"nin body' sinde yer alan username ve passworld alanının doldurulması doğru şekilde doldurulması gerekmektedir. Bu alanlar doldurulduktan sonra istek gönderildiğinde granting ticket, geçerlilik süresi boyunca "cas-gt" ortam değişkeninde tutulacaktır.

Grantig Ticket aldıktan sonra Service Ticket almak için, "0-CAS Request/Service Ticket İsteği"nde bulunulması gerekirmektedir. Bu ortam değişkeninde bulunan "cas-gt" değerini alacak ve elde edilen service ticket' ı diğer bir ortam değişkeni olan "cas-st" ye atayacaktır.

İstek yapılmak istenilen servis ile ilgili sorgu açıldığında istek alanları doğru şekilde doldurulduktan sonra istek gönderilebilir.

Her istek için bir "cas-st" sorgusu yapılması gerekmektedir. Bu değer çevre değişkenleri vasıtasıyla isteklerin header alanında bulunan {{service-ticket}} alanına {{cas-st}} ile geçilecektir.

Servis Detayları

Bu bölümden kategorilerine göre Servis çağırım detayları ile ilgili bilgilere ulaşabilirsiniz.

1. Endeks Ölçüm Rest Servisi

1.1. Endeks Ölçümü nasıl kaydedilir?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İstek
<?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>
Örnek XML Cevap
<?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>
Örnek Json İstek
{
  "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
            }
    ]
  }
}
Örnek Json Cevap
{
  "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. Kayıtlı endeks ölçümleri nasıl sorgulanır?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İstek
<?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>
Örnek XML Cevap
<?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>
Örnek Json İstek
{
  "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
    }
  }
}
Örnek Json Cevap
{
  "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. Kayıtlı endeks ölçümleri endeks ID bilgisi ile nasıl sorgulanır?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İstek
<?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>
Örnek XML Cevap
<?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>
Örnek Json İstek
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "indexIds": [40065,40069,40071]
  }
}
Örnek Json Cevap
{
  "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. Kayıtlı aktif endeks ölçümü nasıl iptal edilir/pasife alınır?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İstek
<?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>
Örnek XML Cevap
<?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>
Örnek Json İstek
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "indexIds": [40046,40123,40144]
  }
}
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "cancelledIndexes": [
      40046,
      40123,
      40144
    ]
  }
}

2. Ek Tüketim Rest Servisi

2.1. Ek tüketim bilgisi nasıl kaydedilir?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İstek
<?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>
Örnek XML Cevap
<?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>
Örnek Json İstek
{
  "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":""
            }
    ]
  }
}
Örnek Json Cevap
{
  "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. Kayıtlı ek tüketim bilgileri nasıl sorgulanır?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İstek
<?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>
Örnek XML Cevap
<?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>
Örnek Json İstek
{
  "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
    }
  }
}
Örnek Json Cevap
{
  "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. Kayıtlı ek tüketim bilgileri ek tükerim ID verisi ile nasıl sorgulanır?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İstek
<?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>
Örnek XML Cevap
<?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>
Örnek Json İstek
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "additionalAccrualIds": [58372,58563]
  }
}
Örnek Json Cevap
{
  "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. Kayıtlı aktif ek tüketim verisi nasıl iptal edilir/pasife alınır?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İstek
<?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>
Örnek XML Cevap
<?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>
Örnek Json İstek
{
  "header": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    },
    {
      "key": "application",
      "value": "app name"
    }
  ],
  "body": {
    "additionalAccrualIds": [58372,58563]
  }
}
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "cancelledAdditionalAccruals": [
      58372,
      58563
    ]
  }
}

3. Dizinler

3.1. Ek tüketim iptal etme/pasife alma servisi

POST /additional-accrual/cancel

3.1.1. Açıklama

Daha önceden yüklenmiş ek tüketim verilerinin iptal işlemini gerçekleştiren servis metodu

3.1.2. Parametreler

Tip İsim Açıklama Şema Varsayılan

Header

ecms-service-ticket
gerekli

CMS Servis ST Header

string

Body

body
opsiyonel

AdditionalAccrualCancelRequest

3.1.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

AdditionalAccrualCancelResponse

3.1.4. Üretilenler

  • application/json

  • application/xml

3.1.5. Etiketler

  • additional-accrual

3.2. Ek tüketim verisi bulma servisi

POST /additional-accrual/find

3.2.1. Açıklama

Daha önceden kaydedilmiş endeks verisini ek tüketim ID bilgisi ile getiren servis metodu

3.2.2. Parametreler

Tip İsim Açıklama Şema Varsayılan

Header

ecms-service-ticket
gerekli

CMS Servis ST Header

string

Body

body
opsiyonel

AdditionalAccrualFindRequest

3.2.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

AdditionalAccrualFindResponse

3.2.4. Üretilenler

  • application/json

  • application/xml

3.2.5. Etiketler

  • additional-accrual

3.3. Ek tüketim kaydetme servisi

POST /additional-accrual/save

3.3.1. Açıklama

Çoklu yeni ek tüketim kaydı işlemini gerçekleştirmek için kullanılan servis metodu.

3.3.2. Parametreler

Tip İsim Açıklama Şema Varsayılan

Header

ecms-service-ticket
gerekli

CMS Servis ST Header

string

Body

body
opsiyonel

AdditionalAccrualSaveRequest

3.3.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

AdditionalAccrualSaveResponse

3.3.4. Üretilenler

  • application/json

  • application/xml

3.3.5. Etiketler

  • additional-accrual

3.4. Ek tüketim kayıt verisi arama servisi

POST /additional-accrual/search

3.4.1. Açıklama

Yüklenmiş ek tüketim verileri içerisinde arama işlemini gerçekleştiren servis metodu

3.4.2. Parametreler

Tip İsim Açıklama Şema Varsayılan

Header

ecms-service-ticket
gerekli

CMS Servis ST Header

string

Body

body
opsiyonel

AdditionalAccrualSearchRequest

3.4.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

AdditionalAccrualSearchResponse

3.4.4. Üretilenler

  • application/json

  • application/xml

3.4.5. Etiketler

  • additional-accrual

3.5. Endeks iptal etme/pasife alma servisi

POST /index-metering/cancel

3.5.1. Açıklama

Daha önceden yüklenmiş endeks verilerinin iptal işlemini gerçekleştiren servis metodu

3.5.2. Parametreler

Tip İsim Açıklama Şema Varsayılan

Header

ecms-service-ticket
gerekli

CMS Servis ST Header

string

Body

body
opsiyonel

IndexMeteringCancelRequest

3.5.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

IndexMeteringCancelResponse

3.5.4. Üretilenler

  • application/json

  • application/xml

3.5.5. Etiketler

  • index-metering

3.6. Endeks verisi bulma servisi

POST /index-metering/find

3.6.1. Açıklama

Daha önceden kaydedilmiş endeks verisini endeks ID bilgisi ile getiren servis metodu

3.6.2. Parametreler

Tip İsim Açıklama Şema Varsayılan

Header

ecms-service-ticket
gerekli

CMS Servis ST Header

string

Body

body
opsiyonel

IndexMeteringFindRequest

3.6.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

IndexMeteringFindResponse

3.6.4. Üretilenler

  • application/json

  • application/xml

3.6.5. Etiketler

  • index-metering

3.7. Endeks Kaydetme Servisi

POST /index-metering/save

3.7.1. Açıklama

Çoklu yeni endeks kaydı işlemini gerçekleştirmek için kullanılan servis metodu.

3.7.2. Parametreler

Tip İsim Açıklama Şema Varsayılan

Header

ecms-service-ticket
gerekli

CMS Servis ST Header

string

Body

body
gerekli

Endeks yükleme isteği

IndexMeteringSaveRequest

3.7.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

IndexMeteringSaveResponse

3.7.4. Üretilenler

  • application/json

  • application/xml

3.7.5. Etiketler

  • index-metering

3.8. Endeks kayıt verisi arama servisi

POST /index-metering/search

3.8.1. Açıklama

Yüklenmiş endeks verileri içerisinde arama işlemini gerçekleştiren servis metodu

3.8.2. Parametreler

Tip İsim Açıklama Şema Varsayılan

Header

ecms-service-ticket
gerekli

CMS Servis ST Header

string

Body

body
opsiyonel

IndexMeteringSearchRequest

3.8.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

IndexMeteringSearchResponse

3.8.4. Üretilenler

  • application/json

  • application/xml

3.8.5. Etiketler

  • index-metering

4. Tanımlar

4.1. AdditionalAccrualCancelRequest

Ek tüketim verisi iptal etme isteği

İsim Açıklama Şema

body
gerekli

Ek tüketim verisi iptal etme istek içeriği

AdditionalAccrualCancelRequestBody

header
opsiyonel

Header request bilgisini tutar.

< Header > array

4.2. AdditionalAccrualCancelRequestBody

Ek tüketim verisi iptal etme istek içeriği

İsim Açıklama Şema

additionalAccrualIds
gerekli

İptal edilmek istenen ek tüketim verilerinin ID bilgileri

< integer(int64) > array

4.3. AdditionalAccrualCancelResponse

Ek tüketim verisi iptal işlemi cevabı

İsim Açıklama Şema

body
opsiyonel

Ek tüketim verisi iptal işleminin cevap içeriği

AdditionalAccrualCancelResponseBody

resultCode
gerekli

0 başarılı diğer hallerde hata kodu içerir.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumda OK diğer hallerde hatanın açıklamasını içerir
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , bir iş kuralına takıldıysanız BUSINESSERROR , bir sistem hatası ile karşılaşırsanız SYSTEMERROR döner.
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.4. AdditionalAccrualCancelResponseBody

Ek tüketim verisi iptal işleminin cevap içeriği

İsim Açıklama Şema

cancelledAdditionalAccruals
opsiyonel

İptal edilen ek tüketim verilerinin ID bilgileri

< integer(int64) > array

4.5. AdditionalAccrualFindRequest

Ek tüketim verisi bulma isteği

İsim Açıklama Şema

body
gerekli

Ek tüketim verisi bulma istek içeriği

AdditionalAccrualFindRequestBody

header
opsiyonel

Header request bilgisini tutar.

< Header > array

4.6. AdditionalAccrualFindRequestBody

Ek tüketim verisi bulma istek içeriği

İsim Açıklama Şema

additionalAccrualIds
gerekli

Bulunması istenen ek tüketimlerin ID listesi

< integer(int64) > array

4.7. AdditionalAccrualFindResponse

Ek tüketim verisi bulma işlemi cevabı

İsim Açıklama Şema

body
opsiyonel

Ek tüketim verisi bulma işleminin cevap içeriği

AdditionalAccrualFindResponseBody

resultCode
gerekli

0 başarılı diğer hallerde hata kodu içerir.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumda OK diğer hallerde hatanın açıklamasını içerir
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , bir iş kuralına takıldıysanız BUSINESSERROR , bir sistem hatası ile karşılaşırsanız SYSTEMERROR döner.
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.8. AdditionalAccrualFindResponseBody

Ek tüketim verisi bulma işleminin cevap içeriği

İsim Açıklama Şema

additionalAccruals
opsiyonel

Bulunan ek tüketim verileri

< AdditionalAccrualQueryResponseModel > array

4.9. AdditionalAccrualQueryResponseModel

Ek tüketim ölçümü arama sonucu modeli

İsim Açıklama Şema

additionalAccrualId
opsiyonel

Ek tüketim kaydı ID değeri

integer(int64)

demand
opsiyonel

Ek tüketim demand değeri

number

description
opsiyonel

Ek tüketim açıklaması (Ek tüketim nedeni diğer seçildiğinde zorunludur)

string

editingDate
opsiyonel

Ek Tüketim Güncelleme Tarihi

string(date-time)

endDate
opsiyonel

Ek tüketim bitiş tarihi

string(date-time)

lineLoss
opsiyonel

Hat kaybı olup olmadığı bilgisi (0:YOK,1:VAR)

integer(int32)

measuringOrgId
opsiyonel

Sayaç okuyan kurum bilgisi

integer(int64)

meteringPointEic
opsiyonel

Ölçüm noktası EIC

string

meteringPointId
opsiyonel

Ölçüm noktası ID

integer(int64)

period
opsiyonel

Ölçüm periodu

string(date-time)

rc
opsiyonel

Ek tüketim RC değeri

number

reason
opsiyonel

Ek tüketim nedeni MEASURING_CIRCUIT_FAILURE(Ölçü Devresi Arızası), METER_RECORDING_ERROR(Sayacın hatalı tüketim kaydetmesi), METER_MEASURING_FAULT(Sayacın Ölçüm Yapamaması), WRONG_FACTOR_RECORD(Hatalı çarpan kaydı), METER_DIGIT_FAULT(Sayaç Hane sayısı Hatası), PLANT_CONSUMPTION_WITHOUT_MEASURING_CIRCUIT(Ölçü devresiz tesis tüketimi), MEASURING_ERROR(Hatalı Ölçüm), OTHER(Diğer)

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
opsiyonel

Ek tüketim kayıt tarihi

string(date-time)

ri
opsiyonel

Ek tüketim RI değeri

number

startDate
opsiyonel

Ek tüketim başlangıç tarihi

string(date-time)

state
opsiyonel

Kayıt işlem bilgisi

string

status
opsiyonel

Ek tüketim durum bilgisi

enum (ACTIVE, PASSIVE)

supplierOrgId
opsiyonel

Tedarikçi kurum ID bilgisi (Sadece EPİAŞ kullanıcıları için)

integer(int64)

t0
opsiyonel

Ek tüketim T0 değeri

number

t1
opsiyonel

Ek tüketim T1 değeri

number

t2
opsiyonel

Ek tüketim T2 değeri

number

t3
opsiyonel

Ek tüketim T3 değeri

number

transformerLoss
opsiyonel

Trafo kaybı olup olmadığı bilgisi (0:YOK,1:VAR)

integer(int32)

4.10. AdditionalAccrualRequestModel

Ek tüketim verisi yükleme isteği modeli

İsim Açıklama Şema

demand
opsiyonel

Ek tüketim demand değeri

number

description
opsiyonel

Ek tüketim açıklaması (Ek tüketim nedeni diğer sçildiğinde zorunludur)

string

endDate
gerekli

Ek tüketim bitiş tarihi

string(date-time)

meteringPointEic
gerekli

Ölçüm noktası EIC

string

meteringPointId
gerekli

Ölçüm noktası ID

integer(int64)

period
gerekli

Ölçüm periodu

string(date-time)

rc
opsiyonel

Ek tüketim RC değeri

number

reason
gerekli

Ek tüketim nedeni MEASURING_CIRCUIT_FAILURE(Ölçü Devresi Arızası), METER_RECORDING_ERROR(Sayacın hatalı tüketim kaydetmesi), METER_MEASURING_FAULT(Sayacın Ölçüm Yapamaması), WRONG_FACTOR_RECORD(Hatalı çarpan kaydı), METER_DIGIT_FAULT(Sayaç Hane sayısı Hatası), PLANT_CONSUMPTION_WITHOUT_MEASURING_CIRCUIT(Ölçü devresiz tesis tüketimi), MEASURING_ERROR(Hatalı Ölçüm), OTHER(Diğer)

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
opsiyonel

Ek tüketim RI değeri

number

startDate
gerekli

Ek tüketim başlangıç tarihi

string(date-time)

t0
opsiyonel

Ek tüketim T0 değeri

number

t1
opsiyonel

Ek tüketim T1 değeri

number

t2
opsiyonel

Ek tüketim T2 değeri

number

t3
opsiyonel

Ek tüketim T3 değeri

number

4.11. AdditionalAccrualResponseModel

Ek tüketim verisi sonuç modeli

İsim Açıklama Şema

additionalAccrualId
opsiyonel

Ek tüketim kaydı ID değeri

integer(int64)

demand
opsiyonel

Ek tüketim demand değeri

number

description
opsiyonel

Ek tüketim açıklaması (Ek tüketim nedeni diğer seçildiğinde zorunludur)

string

editingDate
opsiyonel

Ek Tüketim Güncelleme Tarihi

string(date-time)

endDate
opsiyonel

Ek tüketim bitiş tarihi

string(date-time)

measuringOrgId
opsiyonel

Sayaç okuyan kurum bilgisi

integer(int64)

meteringPointEic
opsiyonel

Ölçüm noktası EIC

string

meteringPointId
opsiyonel

Ölçüm noktası ID

integer(int64)

period
opsiyonel

Ölçüm periodu

string(date-time)

rc
opsiyonel

Ek tüketim RC değeri

number

reason
opsiyonel

Ek tüketim nedeni MEASURING_CIRCUIT_FAILURE(Ölçü Devresi Arızası), METER_RECORDING_ERROR(Sayacın hatalı tüketim kaydetmesi), METER_MEASURING_FAULT(Sayacın Ölçüm Yapamaması), WRONG_FACTOR_RECORD(Hatalı çarpan kaydı), METER_DIGIT_FAULT(Sayaç Hane sayısı Hatası), PLANT_CONSUMPTION_WITHOUT_MEASURING_CIRCUIT(Ölçü devresiz tesis tüketimi), MEASURING_ERROR(Hatalı Ölçüm), OTHER(Diğer)

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
opsiyonel

Ek tüketim kayıt tarihi

string(date-time)

ri
opsiyonel

Ek tüketim RI değeri

number

startDate
opsiyonel

Ek tüketim başlangıç tarihi

string(date-time)

state
opsiyonel

Kayıt işlem bilgisi

string

status
opsiyonel

Ek tüketim durum bilgisi

enum (ACTIVE, PASSIVE)

t0
opsiyonel

Ek tüketim T0 değeri

number

t1
opsiyonel

Ek tüketim T1 değeri

number

t2
opsiyonel

Ek tüketim T2 değeri

number

t3
opsiyonel

Ek tüketim T3 değeri

number

4.12. AdditionalAccrualSaveRequest

Ek tüketim yükleme isteği

İsim Açıklama Şema

body
gerekli

Ek tüketim yükleme istek içeriği

AdditionalAccrualSaveRequestBody

header
opsiyonel

Header request bilgisini tutar.

< Header > array

4.13. AdditionalAccrualSaveRequestBody

Ek tüketim yükleme istek içeriği

İsim Açıklama Şema

additionalAccruals
gerekli

Yüklenecek ek tüketim verileri

< AdditionalAccrualRequestModel > array

4.14. AdditionalAccrualSaveResponse

Ek tüketim yükleme işlem cevabı

İsim Açıklama Şema

body
gerekli

Ek tüketim yükleme işleminin cevap içeriği

AdditionalAccrualSaveResponseBody

resultCode
gerekli

0 başarılı diğer hallerde hata kodu içerir.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumda OK diğer hallerde hatanın açıklamasını içerir
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , bir iş kuralına takıldıysanız BUSINESSERROR , bir sistem hatası ile karşılaşırsanız SYSTEMERROR döner.
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.15. AdditionalAccrualSaveResponseBody

Ek tüketim yükleme işleminin cevap içeriği

İsim Açıklama Şema

additionalAccruals
gerekli

Yüklenen ek tüketim bilgileri

< AdditionalAccrualResponseModel > array

4.16. AdditionalAccrualSearchCriterias

Ek tüketim verisi arama kriterleri

İsim Açıklama Şema

editingDate
opsiyonel

Ek tüketim verisi güncelleme tarihi

string(date-time)

endDate
opsiyonel

Bitiş tarihi kriteri

string(date-time)

measuringOrgId
opsiyonel

Sayaç okuyan kurum ID bilgisi kriteri (Sadece tedarikçiler ve EPİAŞ kullanıcıları için)

integer(int64)

meteringPointEic
opsiyonel

Ölçüm noktası EIC kriteri

string

meteringPointId
opsiyonel

Ölçüm noktası ID kriteri

integer(int64)

period
opsiyonel

Dönem kriteri

string(date-time)

recordDateBegin
opsiyonel

Ek tüketim verisi kayıt tarihi aralığı başlangıcı

string(date-time)

recordDateEnd
opsiyonel

Ek tüketim verisi kayıt tarihi aralığı bitişi

string(date-time)

startDate
opsiyonel

Başlangıç tarihi kriteri

string(date-time)

status
opsiyonel

Ek tüketim verisi durum kriteri

enum (ACTIVE, PASSIVE)

supplierOrgId
opsiyonel

Tedarikçi kurum ID bilgisi kriteri (Sadece EPİAŞ kullanıcıları için)

integer(int64)

4.17. AdditionalAccrualSearchRequest

Ek tüketim verisi arama isteği

İsim Açıklama Şema

body
gerekli

Ek tüketim verisi arama istek içeriği

AdditionalAccrualSearchRequestBody

header
opsiyonel

Header request bilgisini tutar.

< Header > array

4.18. AdditionalAccrualSearchRequestBody

Ek tüketim verisi arama istek içeriği

İsim Açıklama Şema

criterias
gerekli

Ek tüketim verisi arama isteği kriter bilgisi

AdditionalAccrualSearchCriterias

range
opsiyonel

Getirilmesi istenen kayıt sayısını başlangıç ve bitiş endeks numaraları ile belirtir.

Range

4.19. AdditionalAccrualSearchResponse

Ek tüketim verisi arama sonucu

İsim Açıklama Şema

body
opsiyonel

Ek tüketim verisi arama sonucu içeriği

AdditionalAccrualSearchResponseBody

resultCode
gerekli

0 başarılı diğer hallerde hata kodu içerir.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumda OK diğer hallerde hatanın açıklamasını içerir
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , bir iş kuralına takıldıysanız BUSINESSERROR , bir sistem hatası ile karşılaşırsanız SYSTEMERROR döner.
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.20. AdditionalAccrualSearchResponseBody

Ek tüketim verisi arama sonucu içeriği

İsim Açıklama Şema

additionalAccruals
opsiyonel

Ek tüketim verisi arama sonucunde gelen ek tüketim kayıtları listesi

< AdditionalAccrualQueryResponseModel > array

queryInformation
opsiyonel

Servis cevabı içerisinde kaç adet kayıt döndüğünü ve bu kayıtların hangi range aralığında olduğu bilgilerini içerir.

QueryInformation

4.21. Header

Header request bilgisini tutar.

İsim Açıklama Şema

key
opsiyonel

Header key bilgisini tutar.
Örnek : "transactionId"

string

value
opsiyonel

Header value bilgisini tutar.
Örnek : "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"

string

4.22. IndexMeteringCancelRequest

Endeks verisi iptal etme isteği

İsim Açıklama Şema

body
gerekli

Endeks verisi iptal etme istek içeriği

IndexMeteringCancelRequestBody

header
opsiyonel

Header request bilgisini tutar.

< Header > array

4.23. IndexMeteringCancelRequestBody

Endeks verisi iptal etme istek içeriği

İsim Açıklama Şema

indexIds
gerekli

İptal edilmek istenen endeks verilerinin ID bilgileri

< integer(int64) > array

4.24. IndexMeteringCancelResponse

Endeks verisi iptal işlemi cevabı

İsim Açıklama Şema

body
opsiyonel

Endeks verisi iptal işleminin cevap içeriği

IndexMeteringCancelResponseBody

resultCode
gerekli

0 başarılı diğer hallerde hata kodu içerir.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumda OK diğer hallerde hatanın açıklamasını içerir
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , bir iş kuralına takıldıysanız BUSINESSERROR , bir sistem hatası ile karşılaşırsanız SYSTEMERROR döner.
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.25. IndexMeteringCancelResponseBody

Endeks verisi iptal işleminin cevap içeriği

İsim Açıklama Şema

cancelledIndexes
opsiyonel

İptal edilen endeks verilerinin ID bilgileri

< integer(int64) > array

4.26. IndexMeteringFindRequest

Endeks verisi bulma isteği

İsim Açıklama Şema

body
gerekli

Endeks verisi bulma istek içeriği

IndexMeteringFindRequestBody

header
opsiyonel

Header request bilgisini tutar.

< Header > array

4.27. IndexMeteringFindRequestBody

Endeks verisi bulma istek içeriği

İsim Açıklama Şema

indexIds
gerekli

Bulunması istenen endekslerin ID listesi

< integer(int64) > array

4.28. IndexMeteringFindResponse

Endeks verisi bulma işlemi cevabı

İsim Açıklama Şema

body
opsiyonel

Endeks verisi bulma işleminin cevap içeriği

IndexMeteringFindResponseBody

resultCode
gerekli

0 başarılı diğer hallerde hata kodu içerir.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumda OK diğer hallerde hatanın açıklamasını içerir
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , bir iş kuralına takıldıysanız BUSINESSERROR , bir sistem hatası ile karşılaşırsanız SYSTEMERROR döner.
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.29. IndexMeteringFindResponseBody

Endeks verisi bulma işleminin cevap içeriği

İsim Açıklama Şema

indexes
opsiyonel

Bulunan endeks verileri

< IndexMeteringQueryResponseModel > array

4.30. IndexMeteringQueryResponseModel

Endeks ölçümü arama sonucu modeli

İsim Açıklama Şema

description
opsiyonel

Ölçüm açıklaması

string

digitCount
opsiyonel

Hane sayısı

integer(int64)

editingDate
opsiyonel

Endeks güncelleme tarihi

string(date-time)

factor
opsiyonel

Çarpan

number

firstLoadType
opsiyonel

İlk yükleme türü. AUTOMATED(OSOS) MANUALLY(Saha okuması) PREDICTED(Tahmin)

enum (AUTOMATED, MANUALLY, PREDICTED)

firstMeasureDate
opsiyonel

İlk okuma tarihi

string(date-time)

firstMeasureType
opsiyonel

İlk okuma türü. PERIODIC(Periyodik Okuma) SUBSCRIPTION(Abonelik Okuması) CLOSING_RELEASE(Kapanış-Tahliye Okuması) METER_CHANGING_DISASSEMBLY(Sayaç Değişimi-Sökme) METER_CHANGING_ASSEMBLY(Sayaç Değişimi-Takma) DEBT_LEAK_TURN_OFF(Borç/Kaçak Kesme Okuması) DEBT_LEAK_TURN_ON(Borç/Kaçak Açma Okuması) INTERIM(Ara Okuma) SUPPLIER_CHANGE (Tedarikçi Değişimi)

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

firstT0
opsiyonel

İlk T0 endeks değeri

number

firstT1
opsiyonel

İlk T1 endeks değeri

number

firstT2
opsiyonel

İlk T2 endeks değeri

number

firstT3
opsiyonel

İlk T3 endeks değeri

number

indexId
opsiyonel

Endeks ID numarası

integer(int64)

lastLoadType
opsiyonel

Son yükleme türü. AUTOMATED(OSOS) MANUALLY(Saha okuması) PREDICTED(Tahmin)

enum (AUTOMATED, MANUALLY, PREDICTED)

lastMeasureDate
opsiyonel

Son okuma tarihi

string(date-time)

lastMeasureType
opsiyonel

Son okuma türü. PERIODIC(Periyodik Okuma) SUBSCRIPTION(Abonelik Okuması) CLOSING_RELEASE(Kapanış-Tahliye Okumas��) METER_CHANGING_DISASSEMBLY(Sayaç Değişimi-Sökme) DEBT_LEAK_TURN_OFF(Borç/Kaçak Kesme Okuması) INTERIM(Ara Okuma) SUPPLIER_CHANGE (Tedarikçi Değişimi) * METER_CHANGING_ASSEMBLY ve DEBT_LEAK_TURN_ON gönderilmemeli. *

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

lastT0
opsiyonel

Son T0 endeks değeri

number

lastT1
opsiyonel

Son T1 endeks değeri

number

lastT2
opsiyonel

Son T2 endeks değeri

number

lastT3
opsiyonel

Son T3 endeks değeri

number

lineLoss
opsiyonel

Hat kaybı olup olmadığı bilgisi (0:YOK,1:VAR)

integer(int32)

measuringOrgId
opsiyonel

Sayaç okuyan kurum bilgisi

integer(int64)

meterBrand
opsiyonel

Sayaç modeli

string

meterSerialNumber
opsiyonel

Sayaç seri numarası

string

meterType
opsiyonel

Sayaç türü. MECHANICAL(Mekanik) ELECTRONIC(Elektronik)

enum (MECHANICAL, ELECTRONIC)

meteringPointEic
opsiyonel

Ölçüm noktası EIC

string

meteringPointId
opsiyonel

Ölçüm noktası ID

integer(int64)

period
opsiyonel

Ölçüm periodu

string(date-time)

periodDescription
gerekli

Periyod Ölçüm Açıklama

string

powerType
opsiyonel

Enerji türü. ACTIVE(Aktif) INDUCTIVE(İndüktif) CAPACITIVE(Kapasitif) DEMAND(Demand)

enum (ACTIVE, INDUCTIVE, CAPACITIVE, DEMAND)

recordDate
opsiyonel

Endeks kayıt tarihi

string(date-time)

state
opsiyonel

Kayıt işlem bilgisi

string

status
opsiyonel

Endeks ölçümünün durum bilgisi

enum (ACTIVE, PASSIVE, OLD_VERSION)

supplierOrgId
opsiyonel

Tedarikçi kurum ID bilgisi (Sadece EPİAŞ kullanıcıları için)

integer(int64)

transformerLoss
opsiyonel

Trafo kaybı olup olmadığı bilgisi (0:YOK,1:VAR)

integer(int32)

4.31. IndexMeteringRequestModel

Endeks ölçüm verisi yükleme isteği modeli

İsim Açıklama Şema

description
opsiyonel

Ölçüm açıklaması

string

digitCount
opsiyonel

Hane Sayısı

integer(int64)

factor
gerekli

Çarpan

number

firstLoadType
gerekli

İlk yükleme türü. AUTOMATED(OSOS) MANUALLY(Saha okuması) PREDICTED(Tahmin)

enum (AUTOMATED, MANUALLY, PREDICTED)

firstMeasureDate
gerekli

İlk okuma tarihi

string(date-time)

firstMeasureType
gerekli

İlk okuma türü. PERIODIC(Periyodik Okuma) SUBSCRIPTION(Abonelik Okuması) CLOSING_RELEASE(Kapanış-Tahliye Okuması) METER_CHANGING_DISASSEMBLY(Sayaç Değişimi-Sökme) METER_CHANGING_ASSEMBLY(Sayaç Değişimi-Takma) DEBT_LEAK_TURN_OFF(Borç/Kaçak Kesme Okuması) DEBT_LEAK_TURN_ON(Borç/Kaçak Açma Okuması) INTERIM(Ara Okuma) SUPPLIER_CHANGE (Tedarikçi Değişimi)

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

firstT0
opsiyonel

İlk T0 endeks değeri

number

firstT1
opsiyonel

İlk T1 endeks değeri

number

firstT2
opsiyonel

İlk T2 endeks değeri

number

firstT3
opsiyonel

İlk T3 endeks değeri

number

lastLoadType
gerekli

Son yükleme türü. AUTOMATED(OSOS) MANUALLY(Saha okuması) PREDICTED(Tahmin)

enum (AUTOMATED, MANUALLY, PREDICTED)

lastMeasureDate
gerekli

Son okuma tarihi

string(date-time)

lastMeasureType
gerekli

Son okuma türü. PERIODIC(Periyodik Okuma) SUBSCRIPTION(Abonelik Okuması) CLOSING_RELEASE(Kapanış-Tahliye Okuması) METER_CHANGING_DISASSEMBLY(Sayaç Değişimi-Sökme) DEBT_LEAK_TURN_OFF(Borç/Kaçak Kesme Okuması) INTERIM(Ara Okuma) SUPPLIER_CHANGE (Tedarikçi Değişimi) * METER_CHANGING_ASSEMBLY ve DEBT_LEAK_TURN_ON gönderilmemeli. *

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

lastT0
opsiyonel

Son T0 endeks değeri

number

lastT1
opsiyonel

Son T1 endeks değeri

number

lastT2
opsiyonel

Son T2 endeks değeri

number

lastT3
opsiyonel

Son T3 endeks değeri

number

meterBrand
gerekli

Sayaç modeli

string

meterSerialNumber
gerekli

Sayaç seri numarası

string

meterType
gerekli

Sayaç türü. MECHANICAL(Mekanik) ELECTRONIC(Elektronik)

enum (MECHANICAL, ELECTRONIC)

meteringPointEic
gerekli

Ölçüm noktası EIC

string

meteringPointId
gerekli

Ölçüm noktası ID

integer(int64)

period
gerekli

Ölçüm periodu

string(date-time)

periodDescription
gerekli

Periyod Ölçüm Açıklama

string

powerType
gerekli

Endeks türü. ACTIVE(Aktif) INDUCTIVE(İndüktif) CAPACITIVE(Kapasitif) DEMAND(Demand)

enum (ACTIVE, INDUCTIVE, CAPACITIVE, DEMAND)

4.32. IndexMeteringResponseModel

Endeks ölçüm verisi sonuç modeli

İsim Açıklama Şema

description
opsiyonel

Ölçüm açıklaması

string

digitCount
opsiyonel

Hane sayısı

integer(int64)

editingDate
opsiyonel

Endeks güncelleme tarihi

string(date-time)

factor
opsiyonel

Çarpan

number

firstLoadType
opsiyonel

İlk yükleme türü. AUTOMATED(OSOS) MANUALLY(Saha okuması) PREDICTED(Tahmin)

enum (AUTOMATED, MANUALLY, PREDICTED)

firstMeasureDate
opsiyonel

İlk okuma tarihi

string(date-time)

firstMeasureType
opsiyonel

İlk okuma türü. PERIODIC(Periyodik Okuma) SUBSCRIPTION(Abonelik Okuması) CLOSING_RELEASE(Kapanış-Tahliye Okuması) METER_CHANGING_DISASSEMBLY(Sayaç Değişimi-Sökme) METER_CHANGING_ASSEMBLY(Sayaç Değişimi-Takma) DEBT_LEAK_TURN_OFF(Borç/Kaçak Kesme Okuması) DEBT_LEAK_TURN_ON(Borç/Kaçak Açma Okuması) INTERIM(Ara Okuma) SUPPLIER_CHANGE (Tedarikçi Değişimi)

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

firstT0
opsiyonel

İlk T0 endeks değeri

number

firstT1
opsiyonel

İlk T1 endeks değeri

number

firstT2
opsiyonel

İlk T2 endeks değeri

number

firstT3
opsiyonel

İlk T3 endeks değeri

number

indexId
opsiyonel

Endeks ID numarası

integer(int64)

lastLoadType
opsiyonel

Son yükleme türü. AUTOMATED(OSOS) MANUALLY(Saha okuması) PREDICTED(Tahmin)

enum (AUTOMATED, MANUALLY, PREDICTED)

lastMeasureDate
opsiyonel

Son okuma tarihi

string(date-time)

lastMeasureType
opsiyonel

Son okuma türü. PERIODIC(Periyodik Okuma) SUBSCRIPTION(Abonelik Okuması) CLOSING_RELEASE(Kapanış-Tahliye Okumas��) METER_CHANGING_DISASSEMBLY(Sayaç Değişimi-Sökme) DEBT_LEAK_TURN_OFF(Borç/Kaçak Kesme Okuması) INTERIM(Ara Okuma) SUPPLIER_CHANGE (Tedarikçi Değişimi) * METER_CHANGING_ASSEMBLY ve DEBT_LEAK_TURN_ON gönderilmemeli. *

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

lastT0
opsiyonel

Son T0 endeks değeri

number

lastT1
opsiyonel

Son T1 endeks değeri

number

lastT2
opsiyonel

Son T2 endeks değeri

number

lastT3
opsiyonel

Son T3 endeks değeri

number

measuringOrgId
opsiyonel

Sayaç okuyan kurum bilgisi

integer(int64)

meterBrand
opsiyonel

Sayaç modeli

string

meterSerialNumber
opsiyonel

Sayaç seri numarası

string

meterType
opsiyonel

Sayaç türü. MECHANICAL(Mekanik) ELECTRONIC(Elektronik)

enum (MECHANICAL, ELECTRONIC)

meteringPointEic
opsiyonel

Ölçüm noktası EIC

string

meteringPointId
opsiyonel

Ölçüm noktası ID

integer(int64)

period
opsiyonel

Ölçüm periodu

string(date-time)

periodDescription
gerekli

Periyod Ölçüm Açıklama

string

powerType
opsiyonel

Enerji türü. ACTIVE(Aktif) INDUCTIVE(İndüktif) CAPACITIVE(Kapasitif) DEMAND(Demand)

enum (ACTIVE, INDUCTIVE, CAPACITIVE, DEMAND)

recordDate
opsiyonel

Endeks kayıt tarihi

string(date-time)

state
opsiyonel

Kayıt işlem bilgisi

string

status
opsiyonel

Endeks ölçümünün durum bilgisi

enum (ACTIVE, PASSIVE, OLD_VERSION)

4.33. IndexMeteringSaveRequest

Endeks yükleme isteği

İsim Açıklama Şema

body
gerekli

Endeks yükleme istek içeriği

IndexMeteringSaveRequestBody

header
opsiyonel

Header request bilgisini tutar.

< Header > array

4.34. IndexMeteringSaveRequestBody

Endeks yükleme istek içeriği

İsim Açıklama Şema

indexes
gerekli

Yükleme yapılacak endeksler

< IndexMeteringRequestModel > array

4.35. IndexMeteringSaveResponse

Endeks yükleme işlem cevabı

İsim Açıklama Şema

body
gerekli

Endeks yükleme işleminin cevap içeriği

IndexMeteringSaveResponseBody

resultCode
gerekli

0 başarılı diğer hallerde hata kodu içerir.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumda OK diğer hallerde hatanın açıklamasını içerir
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , bir iş kuralına takıldıysanız BUSINESSERROR , bir sistem hatası ile karşılaşırsanız SYSTEMERROR döner.
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.36. IndexMeteringSaveResponseBody

Endeks yükleme işleminin cevap içeriği

İsim Açıklama Şema

indexes
opsiyonel

Yüklenen endekslerin bilgileri

< IndexMeteringResponseModel > array

4.37. IndexMeteringSearchCriterias

Endeks verisi arama kriterleri

İsim Açıklama Şema

editingDate
opsiyonel

Endeks verisi güncelleme tarihi

string(date-time)

firstMeasureDate
opsiyonel

İlk ölçüm noktası kriteri

string(date-time)

indexId
opsiyonel

Endeks ID kriteri

integer(int64)

lastMeasureDate
opsiyonel

Son ölçüm noktası kriteri

string(date-time)

measuringOrgId
opsiyonel

Sayaç okuyan kurum ID bilgisi kriteri (Sadece tedarikçiler ve EPİAŞ kullanıcıları için)

integer(int64)

meterSerialNumber
opsiyonel

Sayaç seri numarası kriteri

string

meteringPointEic
opsiyonel

Ölçüm noktası EIC kriteri

string

meteringPointId
opsiyonel

Ölçüm noktası ID kriteri

integer(int64)

period
opsiyonel

Dönem kriteri

string(date-time)

periodInterval
opsiyonel

Dönem aralık kriteri. Verilen dönemin bir yıl öncesine kadar veri alınmasını sağlar.

string(date-time)

powerType
opsiyonel

Endeks verisi endeks türü kriteri

enum (ACTIVE, INDUCTIVE, CAPACITIVE, DEMAND)

recordDateBegin
opsiyonel

Endeks verisi kayıt tarihi aralığı başlangıcı

string(date-time)

recordDateEnd
opsiyonel

Endeks verisi kayıt tarihi aralığı bitişi

string(date-time)

status
opsiyonel

Endeks verisi durum kriteri

enum (ACTIVE, PASSIVE, OLD_VERSION)

supplierOrgId
opsiyonel

Tedarikçi kurum ID bilgisi kriteri (Sadece EPİAŞ kullanıcıları için)

integer(int64)

4.38. IndexMeteringSearchRequest

Endeks verisi arama isteği

İsim Açıklama Şema

body
gerekli

Endeks verisi arama istek içeriği

IndexMeteringSearchRequestBody

header
opsiyonel

Header request bilgisini tutar.

< Header > array

4.39. IndexMeteringSearchRequestBody

Endeks verisi arama istek içeriği

İsim Açıklama Şema

criterias
gerekli

Endeks verisi arama isteği kriter bilgisi

IndexMeteringSearchCriterias

range
opsiyonel

Getirilmesi istenen kayıt sayısını başlangıç ve bitiş endeks numaraları ile belirtir.

Range

4.40. IndexMeteringSearchResponse

Endeks verisi arama sonucu

İsim Açıklama Şema

body
opsiyonel

Endeks verisi arama sonucu içeriği

IndexMeteringSearchResponseBody

resultCode
gerekli

0 başarılı diğer hallerde hata kodu içerir.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumda OK diğer hallerde hatanın açıklamasını içerir
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , bir iş kuralına takıldıysanız BUSINESSERROR , bir sistem hatası ile karşılaşırsanız SYSTEMERROR döner.
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

4.41. IndexMeteringSearchResponseBody

Endeks verisi arama sonucu içeriği

İsim Açıklama Şema

indexes
opsiyonel

Endeks verisi arama sonucunde gelen endeks kayıtları listesi

< IndexMeteringQueryResponseModel > array

queryInformation
opsiyonel

Servis cevabı içerisinde kaç adet kayıt döndüğünü ve bu kayıtların hangi range aralığında olduğu bilgilerini içerir.

QueryInformation

4.42. QueryInformation

Servis cevabı içerisinde kaç adet kayıt döndüğünü ve bu kayıtların hangi range aralığında olduğu bilgilerini içerir.

İsim Açıklama Şema

begin
opsiyonel

Başlangıç range değerini tutar.
Örnek : 1

integer(int32)

count
opsiyonel

Toplam kayıt sayısı bilgisini tutar.
Örnek : 4444

integer(int32)

end
opsiyonel

Bitiş range değerini tutar.
Örnek : 10

integer(int32)

4.43. Range

Getirilmesi istenen kayıt sayısını başlangıç ve bitiş endeks numaraları ile belirtir.

İsim Açıklama Şema

begin
opsiyonel

Başlangıç range değerini tutar.
Örnek : 1

integer(int32)

end
opsiyonel

Bitiş range değerini tutar.
Örnek : 10

integer(int32)