Genel Bakış

Versiyon bilgisi

Versiyon : 1.0.0

URI şeması

Sunucu : epys-prp.epias.com.tr
Kök Dizin : /index-ac
Şemalar : HTTPS

Etiketler

  • additionalConsumption

  • index

  • indexAcLookup

  • readObligation

  • summaryReport

Doküman Hakkında

Bu dokümanda Endeks/Ek Tüketim servislerinin tanımları ve bu servislerin nasıl çağrılacağı anlatılmaktadır.

1. EPYS Endeks/Ek Tüketim Servisleri Hakkında

EPYS Endeks/Ek Tüketim uygulaması REST servisler üzerine kuruludur. JSON ve XML isteklerini kabul eder ve gelen isteğe göre JSON yada XML cevap döner.

Uygulamanın kullanıcı arayüzünde görmüş olduğunuz bilgilerin tamamı dışarıya açık olan bu servislerden alınmaktadır. Bu arayüzü kullanmadan da sahip olduğunuz uygulamalar ile sistemi kullanmanız mümkündür.

Uygulamayı çağırabilmek için EKYS 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 (https://cas.epias.com.tr) TGT alınarak gönderilmelidir.

2. İstemci Oluşturmak

Servis dokümantasyonu Swagger ile hazırlanmıştır. Test ortamı için https://epys-prp.epias.com.tr/index-ac/technical/swagger.json gerçek ortam için https://epys.epias.com.tr/index-ac/technical/swagger.json dosyasını kullanarak https://generator.swagger.io adresinden kullandığınız dile uygun istemci kodlarını oluşturabilirsiniz.

3. EPYS Endeks/Ek Tüketim Uygulaması 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 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.

3.1. Ticket Granting Ticket (TGT) Oluşturma

TGT oluşturmak için https://cas.epias.com.tr/cas/v1/tickets?format=text (test ortamı için 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

EKYS Kullanıcı Adı

password

EKYS Ş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=DGPYSUSER&password=DGPYSSIFRE

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

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

3.2. Service Ticket (ST) Oluşturma

ST oluşturabilmeniz için öncelikle geçerli TGT bilgisi almış olmanız gerekmektedir. Alınan TGT bilgisi ile https://cas.epias.com.tr/cas/v1/tickets/TGT-237-U0TU0jUHLyOEIrdoDBEEf3AdRFAXGLifK2ITn4LoY3HfhstGtx-cas02.epias.com.tr adresine aşağıdaki değerleri *POST metodu ile göndermeniz gerekmektedir. ST oluşturabilmeniz için kullanıcak service bilgisi aşağıdaki gibidir. Service ticket bilgisi tek kullanımlık olup 15 saniye içinde kullanılmaz ise geçerliliğini kaybetmektedir.

ortam service

PROD

https://epys.epias.com.tr

TEST

https://epys-prp.epias.com.tr

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

service

https://epys.epias.com.tr
örnek http isteği
POST /cas/v1/tickets/TGT-237-U0TU0jUHLyOEIrdoDBEEf3AdRFAXGLifK2ITn4LoY3HfhstGtx-cas02.epias.com.tr HTTP/1.1
Host: cas.epias.com.tr
Content-Type: application/x-www-form-urlencoded
Content-Length: 39

service=https%3A%2F%2Fepys.epias.com.tr

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

örnek cevap
ST-30853663-c3OsaqpG16IDVGIA3cbs-cashazel-n201

3.3. EPYS Endeks/Ek Tüketim Uygulaması Örnek Mesaj Yapısı

EPYS 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

TGT

(Ticket Granting Ticket) (TGT) Örneğin : TGT-237-U0TU0jUHLyOEIrdoDBEEf3AdRFAXGLifK2ITn4LoY3HfhstGtx-cas02.epias.com.tr

ST

(Service Ticket) (ST) Örneğin : ST-30853663-c3OsaqpG16IDVGIA3cbs-cashazel-n201

Accept

application/json veya application/xml

Content-Type

application/json veya application/xml

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.

Servise gelen ve giden tüm mesajlardaki tarih alanları ISO-8601 formatındadır. Format yyyy-MM-dd’T’HH:mm:ssXXX ş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. Örnek bir zaman değeri şu şekildedir. 2016-03-25T00:00:00+03:00
Ö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:ssXXX");
        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:ssXXX");
        return sdf.format(v);
    }
}
Örnek HTTP Mesajı
POST /reconciliation-res/servis/v1/luy-invoice/invoice/list HTTP/1.1
Host: epys.epias.com.tr
Accept: application/json
Content-Type: application/json
TGT: TGT-237-U0TU0jUHLyOEIrdoDBEEf3AdRFAXGLifK2ITn4LoY3HfhstGtx-cas02.epias.com.tr
Cache-Control: no-cache
{
  "effectiveDate": "2019-04-01T00:00:00+03:00"
}
Örnek JSON Mesajı
{
   "status":"200 OK",
   "correlationId":"(NotUsingGateway)b09d8806-46b9-4703-b185-2167bf74e55e",
   "spanIds":"14826",
   "hostName":"10.199.199.67",
   "clientIp":"127.0.0.1",
   "userName":"NA",
   "successMessage":null,
   "errors":null,
   "body":{
      "content":{
          "completed": true
      }
   }
}

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 status değeri. İ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

status

string

"200 OK" başarılı diğer hallerde hata kodu içerir

Aldığınız hatanın HTTP status kodunu dönmektedir.

error

list

başarılı durumda liste null dönmektedir

Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

correlationId

string

yapmış olduğunuz isteği tekilleştirmeye yarar spanIds ile birlikte

hata almanız durumunad bu bilgi ile birlikte spanIds göndermeniz zorunludur.

spanIds

string

yapmış olduğunuz isteği tekilleştirmeye yarar correlationId ile birlikte

hata almanız durumunad bu bilgi ile birlikte correlationId göndermeniz zorunludur.
VAL- hata kodu ile başlayan hata mesajlarının olduğunuz istek ile ilgili bir sorun olduğunu belirtir. İsteğinizi gözden geçirmelisiniz veya iş kurallarını kontrol etmelisiniz. APP- hata kodu ile başlayan hata mesajları sistemde bir hata olduğunu belirtir. EPİAŞ irtibata geçmelisiniz.
Örnek Başarılı JSON Cevap Mesajı
{
   "status":"200 OK",
   "correlationId":"b09d8806-46b9-4703-b185-2167bf74e55e",
   "spanIds":"14826",
   "hostName":"1.1.1.1",
   "clientIp":"127.0.0.1",
   "userName":"TESTUSER",
   "successMessage":null,
   "errors":null,
   "body":{
      "content":{
          "completed": true
      }
   }
}
Örnek Hatalı JSON Cevap Mesajı
{
  "status": "400 BAD_REQUEST",
  "correlationId": "b09d8806-46b9-4703-b185-2167bf74e55e!",
  "spanIds": "38048",
  "hostName":"1.1.1.1",
  "clientIp":"127.0.0.1",
  "userName": "TESTUSER",
  "successMessage": null,
  "errors": [
    {
      "errorCode": "VAL-PER-1002",
      "errorMessage": "2020-01-01T00:00:00+03:00[GMT+03:00] tarihi için faturalama dönemi bulunamamıştır. "
    }
  ],
  "body": {}
}

4. Servis Detayları

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

4.1. Ek Tüketim Pasife Alma Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Ek Tüketim İşlemleri - Ek Tüketim Kaydı Pasife Al
Request 
{
    "id": 42,
    "explanation": "Ek Tuketim Pasife Alma Aciklamasi"
}
Response 
{
    "status": "200 OK",
    "correlationId": "c6db6fcc-80d3-403f-9983-c10949ec7f2c",
    "spanIds": "(index-ac)8***7",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": "USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "id": 42,
            "consumptionPointId": 200000**0,
            "eic": "40Z000200000**0I",
            "readingOrganizationId": 1010,
            "meterOwnerOrganizationId": 5780,
            "firstReadDate": "2023-07-21T00:00:00+03:00",
            "lastReadDate": "2023-08-08T00:00:00+03:00",
            "energyType": {
                "id": 1,
                "value": "ACTIVE",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Aktif"
                    }
                ]
            },
            "additionalConsumptionStatus": {
                "id": 2,
                "value": "PASSIVE",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Pasif"
                    }
                ]
            }
        }
    }
}

4.2. Ek Tüketim Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Endeks İşlemleri - Ek Tüketim Listesi Görüntüle
Request 
{
    "eic": "40Z0002000000**I",
    "consumptionPointId": 2000000**,
    "firstReadDateAsPeriod": "2023-07-01T00:00:00+03:00",
    "lastReadDateAsPeriod": "2023-08-01T00:00:00+03:00",
    "energyTypes": [
        1
    ],
    "id": 42,
    "additionalConsumptionStatuses": [
        1
    ],
    "additionalConsumptionReasons": [
        1
    ],
    "createDateStartAsPeriod": "2023-08-01T00:00:00+03:00",
    "createDateEndAsPeriod": "2023-09-01T00:00:00+03:00",
    "page": {
        "number": 1,
        "size": 10,
        "sort": {
            "field": "createDate",
            "direction": "DESC"
        },
        "total": 1
    },
    "readingOrganizationId": "1010",
    "portfolioType": 1,
    "meterOwnerOrganizationId": "5780"
}
Response 
{
    "status": "200 OK",
    "correlationId": "c6db6fcc-80d3-403f-9983-c10949ec7f2c",
    "spanIds": "(index-ac)8***7",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": "USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "items": [
                {
                    "id": 42,
                    "consumptionPointId": 200000000,
                    "eic": "40Z000200000000I",
                    "readingOrganizationId": 1010,
                    "readingOrganizationName": "SAYAC OKUYAN KURUM ADI",
                    "meterOwnerOrganizationId": 5780,
                    "meterOwnerOrganizationName": "ORGANIZASYON ADI",
                    "firstReadDate": "2023-07-21T00:00:00+03:00",
                    "lastReadDate": "2023-08-08T00:00:00+03:00",
                    "createDate": "2023-08-22T14:13:27.795978+03:00",
                    "modifyDate": "2023-08-22T14:13:27.795978+03:00",
                    "createUser": "USER_NAME",
                    "modifyUser": "USER_NAME",
                    "energyType": {
                        "id": 1,
                        "value": "ACTIVE",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Aktif"
                            }
                        ]
                    },
                    "t1": "10",
                    "t2": "10",
                    "t3": "10",
                    "reactiveOrDemand": null,
                    "inductive": null,
                    "capacitive": null,
                    "demand": null,
                    "explanation": "test",
                    "period": 18,
                    "additionalConsumptionStatus": {
                        "id": 1,
                        "value": "ACTIVE",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Aktif"
                            }
                        ]
                    },
                    "additionalConsumptionReason": {
                        "id": 1,
                        "value": "MEASURING_CIRCUIT_FAILURE",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Ölçü Devresi Sorunu"
                            }
                        ]
                    },
                    "uploadPeriod": 14,
                    "portfolioType": {
                        "id": 1,
                        "value": "PORTFOLIO",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Portföy"
                            }
                        ]
                    }
                }
            ],
            "page": {
                "number": 1,
                "size": 10,
                "total": 1,
                "sort": {
                    "field": "createDate",
                    "direction": "DESC"
                }
            },
            "sortableFields": [
                "createDate"
            ]
        }
    }
}

4.3. Ek Tüketim Kayıt Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Ek Tüketim İşlemleri - Ek Tüketim Kaydet
Request 
{
    "capacitive": null,
    "demand": null,
    "energyType": 1,
    "explanation": "Ek Tuketim Kaydetme Aciklamasi",
    "inductive": null,
    "firstReadDate": "2023-08-30T00:00:00+03:00",
    "lastReadDate": "2023-08-31T00:00:00+03:00",
    "t1": 10,
    "t2": 20,
    "t3": 30,
    "additionalConsumptionReason": 1,
    "readingOrganizationId": 1010,
    "eic": "40Z000200000**6H",
    "consumptionPointId": 200000**6
}
Response 
{
    "status": "200 OK",
    "correlationId": "c6db6fcc-80d3-403f-9983-c10949ec7f2c",
    "spanIds": "(index-ac)8***7",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": "USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "id": 61,
            "consumptionPointId": 200000**6,
            "eic": "40Z000200000**6H",
            "readingOrganizationId": 1010,
            "meterOwnerOrganizationId": 5780,
            "firstReadDate": "2023-08-30T00:00:00+03:00",
            "lastReadDate": "2023-08-31T00:00:00+03:00",
            "energyType": {
                "id": 1,
                "value": "ACTIVE",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Aktif"
                    }
                ]
            },
            "additionalConsumptionStatus": {
                "id": 1,
                "value": "ACTIVE",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Aktif"
                    }
                ]
            }
        }
    }
}

4.4. Endeks Kayıt Sayısı Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Endeks İşlemleri - Endeks Listesi Görüntüle
Request 
{
    "eic": "40Z000200000**6H",
    "consumptionPointId": 200000**6,
    "firstReadDateAsPeriod": "2023-08-01T00:00:00+03:00",
    "lastReadDateAsPeriod": "2023-08-01T00:00:00+03:00",
    "energyTypes": [
        1
    ],
    "firstReadTypes": [
        1
    ],
    "lastReadTypes": [
        1
    ],
    "indexId": "10000005216",
    "indexStatuses": [
        1
    ],
    "createDateStartAsPeriod": "2023-08-01T00:00:00+03:00",
    "createDateEndAsPeriod": "2023-09-01T00:00:00+03:00",
    "periodSwitch": false,
    "readingOrganizationId": "1010",
    "portfolioType": 1,
    "meterOwnerOrganizationId": "5780"
}
Response 
{
    "status": "200 OK",
    "correlationId": "c6db6fcc-80d3-403f-9983-c10949ec7f2c",
    "spanIds": "(index-ac)8***7",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": "USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "count": 1
        }
    }
}

4.5. Endeks Dışa Aktarma Yardımcı Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Not: Bu servisi ilk kez çağırırken page objesindeki offsetId alanı boş bırakılmalıdır. Ardından gelecek sorgularda, offsetId bilgisi önceki sorgu yanıtındaki offsetId bilgisi ile doldurulmalıdır.

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Endeks İşlemleri - Endeks Listesi Görüntüle
Request 
{
    "eic": "40Z000200000**6H",
    "consumptionPointId": 200000**6,
    "firstReadDateAsPeriod": "2023-08-01T00:00:00+03:00",
    "lastReadDateAsPeriod": "2023-08-01T00:00:00+03:00",
    "energyTypes": [
        1
    ],
    "firstReadTypes": [
        1
    ],
    "lastReadTypes": [
        1
    ],
    "indexId": "10000005216",
    "indexStatuses": [
        1
    ],
    "createDateStartAsPeriod": "2023-08-01T00:00:00+03:00",
    "createDateEndAsPeriod": "2023-09-01T00:00:00+03:00",
    "page": {
        "limit": "100",
        "offsetId": "1",
        "size": null
    },
    "periodSwitch": false,
    "readingOrganizationId": "1010",
    "portfolioType": 1,
    "meterOwnerOrganizationId": "5780"
}
Response 
{
    "status": "200 OK",
    "correlationId": "c6db6fcc-80d3-403f-9983-c10949ec7f2c",
    "spanIds": "(index-ac)8***7",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": "USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "items": [
                {
                    "indexId": 10000005216,
                    "version": 1,
                    "consumptionPointId": 200000**6,
                    "eic": "40Z000200000**6H",
                    "readingOrganizationId": 1010,
                    "readingOrganizationName": "SAYAC OKUYAN KURUM ADI",
                    "meterOwnerOrganizationId": 5780,
                    "meterOwnerOrganizationName": "ORGANIZASYON ADI",
                    "firstReadDate": "2023-08-04T00:00:00+03:00",
                    "lastReadDate": "2023-08-05T00:00:00+03:00",
                    "createDate": "2023-08-23T22:04:52.588897+03:00",
                    "energyType": {
                        "id": 1,
                        "value": "ACTIVE",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Aktif"
                            }
                        ]
                    },
                    "firstT1": "10",
                    "firstT2": "20",
                    "firstT3": "30",
                    "lastT1": "40",
                    "lastT2": "50",
                    "lastT3": "60",
                    "firstReactiveOrDemand": null,
                    "lastReactive": null,
                    "firstInductive": null,
                    "lastInductive": null,
                    "firstCapacitive": null,
                    "lastCapacitive": null,
                    "demand": null,
                    "factor": 1,
                    "meterBrand": "TEST 1",
                    "meterSerialNumber": "12345T",
                    "digitCount": 2,
                    "firstReadType": {
                        "id": 1,
                        "value": "PERIODIC",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Periyodik Okuma"
                            }
                        ]
                    },
                    "lastReadType": {
                        "id": 1,
                        "value": "PERIODIC",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Periyodik Okuma"
                            }
                        ]
                    },
                    "firstLoadType": {
                        "id": 1,
                        "value": "OSOS",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "OSOS"
                            }
                        ]
                    },
                    "lastLoadType": {
                        "id": 1,
                        "value": "OSOS",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "OSOS"
                            }
                        ]
                    },
                    "explanation": "aciklama",
                    "period": 1,
                    "periodExplanation": null,
                    "indexStatus": {
                        "id": 1,
                        "value": "ACTIVE",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Aktif"
                            }
                        ]
                    },
                    "uploadPeriod": 18,
                    "createUser": "SYSTEM",
                    "portfolioType": {
                        "id": 1,
                        "value": "PORTFOLIO",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Portföy"
                            }
                        ]
                    }
                }
            ],
            "page": {
                "limit": 100,
                "offsetId": 5998,
                "size": 1
            }
        }
    }
}

4.6. Endeks Pasife Alma Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Endeks İşlemleri - Endeks Kaydı Pasife Al
Request 
{
  "explanation": "Endeks Pasife Alma Aciklamasidir",
  "indexId": 10000005212
}
Response 
{
    "status": "200 OK",
    "correlationId": "9a1c2817-e995-42eb-bed3-ada51f0b56f4",
    "spanIds": "(index-ac)8***7",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": "USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "indexId": 10000005212,
            "version": 2,
            "consumptionPointId": 200000**4,
            "eic": "40Z000200000**4C",
            "readingOrganizationId": 1010,
            "meterOwnerOrganizationId": 5780,
            "firstReadDate": "2023-08-15T00:00:00+03:00",
            "lastReadDate": "2023-08-16T00:00:00+03:00",
            "energyType": {
                "id": 1,
                "value": "ACTIVE",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Aktif"
                    }
                ]
            },
            "indexStatus": {
                "id": 2,
                "value": "PASSIVE",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Pasif"
                    }
                ]
            },
            "fullOverrideExist": null
        }
    }
}

4.7. Endeks Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Not: "id" parametresi DGPYS migrasyonu ile gelen kayıtları eşleştirmek için kullanılır.

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Endeks İşlemleri - Endeks Listesi Görüntüle
Request 
{
    "eic": "40Z000200000**54",
    "consumptionPointId": 200000**5,
    "firstReadDateAsPeriod": null,
    "lastReadDateAsPeriod": "2023-08-01T00:00:00+03:00",
    "energyTypes": [
        1
    ],
    "firstReadTypes": [
        1
    ],
    "lastReadTypes": [
        1
    ],
    "indexId": 10000005213,
    "id": 1234,
    "indexStatuses": [
        1
    ],
    "createDateStartAsPeriod": "2023-08-01T00:00:00+03:00",
    "createDateEndAsPeriod": "2023-08-30T00:00:00+03:00",
    "page": {
        "number": 1,
        "size": 10,
        "sort": {
            "field": "createDate",
            "direction": "DESC"
        },
        "total": 10
    },
    "excludedIndexStatuses": [
        3
    ],
    "periodSwitch": false,
    "readingOrganizationId": "1010",
    "portfolioType": 1,
    "meterOwnerOrganizationId": "9082"
}
Response 
{
    "status": "200 OK",
    "correlationId": "292ac7ed-bb68-4f93-8703-3ebee303b4b7",
    "spanIds": "(index-ac)8***7",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": "USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "items": [
                {
                    "id": 1234,
                    "indexId": 10000005213,
                    "version": 1,
                    "consumptionPointId": 200000**5,
                    "eic": "40Z000200000**54",
                    "readingOrganizationId": 1010,
                    "readingOrganizationName": "SAYAC OKUYAN KURUM ADI",
                    "meterOwnerOrganizationId": 9082,
                    "meterOwnerOrganizationName": "TEDARIKCI ORGANIZASYON ADI",
                    "firstReadDate": "2023-08-04T00:00:00+03:00",
                    "lastReadDate": "2023-08-05T00:00:00+03:00",
                    "createDate": "2023-08-23T22:04:52.579896+03:00",
                    "energyType": {
                        "id": 1,
                        "value": "ACTIVE",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Aktif"
                            }
                        ]
                    },
                    "firstT1": 10,
                    "firstT2": 20,
                    "firstT3": 30,
                    "lastT1": 40,
                    "lastT2": 50,
                    "lastT3": 60,
                    "firstReactiveOrDemand": null,
                    "lastReactive": null,
                    "firstInductive": null,
                    "lastInductive": null,
                    "firstCapacitive": null,
                    "lastCapacitive": null,
                    "demand": null,
                    "factor": 1,
                    "meterBrand": "SAYAC MARKA",
                    "meterSerialNumber": "SAYAC SERI NO",
                    "digitCount": 2,
                    "firstReadType": {
                        "id": 1,
                        "value": "PERIODIC",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Periyodik Okuma"
                            }
                        ]
                    },
                    "lastReadType": {
                        "id": 1,
                        "value": "PERIODIC",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Periyodik Okuma"
                            }
                        ]
                    },
                    "firstLoadType": {
                        "id": 1,
                        "value": "OSOS",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "OSOS"
                            }
                        ]
                    },
                    "lastLoadType": {
                        "id": 1,
                        "value": "OSOS",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "OSOS"
                            }
                        ]
                    },
                    "explanation": "aciklama",
                    "period": 1,
                    "periodExplanation": null,
                    "indexStatus": {
                        "id": 1,
                        "value": "ACTIVE",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Aktif"
                            }
                        ]
                    },
                    "uploadPeriod": 18,
                    "createUser": "SYSTEM",
                    "portfolioType": {
                        "id": 1,
                        "value": "PORTFOLIO",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Portföy"
                            }
                        ]
                    }
                }
            ],
            "page": {
                "number": 1,
                "size": 10,
                "total": 1,
                "sort": {
                    "field": "createDate",
                    "direction": "DESC"
                }
            },
            "sortableFields": [
                "createDate"
            ]
        }
    }
}

4.8. Endeks Kayıt Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Endeks İşlemleri - Endeks Kaydet
Request 
{
    "energyType": 1,
    "factor": "1.0",
    "digitCount": 2,
    "meterSerialNumber": "3",
    "meterBrand": "4",
    "firstT1": "10.0",
    "firstT2": "30.0",
    "firstT3": "50.0",
    "lastT1": "20.0",
    "lastT2": "40.0",
    "lastT3": "60.0",
    "firstInductive": null,
    "lastInductive": null,
    "firstCapacitive": null,
    "lastCapacitive": null,
    "demand": null,
    "firstReadType": 1,
    "lastReadType": 1,
    "firstLoadType": 1,
    "lastLoadType": 1,
    "explanation": "Endeks Kaydetme Aciklamasidir",
    "periodExplanation": null,
    "firstReadDate": "2023-08-30T00:00:00+03:00",
    "lastReadDate": "2023-08-31T00:00:00+03:00",
    "readingOrganizationId": 1010,
    "eic": "40Z000200000266H",
    "consumptionPointId": 200000266,
    "overrideFullOverlap": true
}
Response 
{
    "status": "200 OK",
    "correlationId": "c6db6fcc-80d3-403f-9983-c10949ec7f2c",
    "spanIds": "(index-ac)8***7",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": "USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "indexId": 10000006260,
            "version": 1,
            "consumptionPointId": 200000**6,
            "eic": "40Z000200000**6H",
            "readingOrganizationId": 1010,
            "meterOwnerOrganizationId": 5780,
            "firstReadDate": "2023-08-30T00:00:00+03:00",
            "lastReadDate": "2023-08-31T00:00:00+03:00",
            "energyType": {
                "id": 1,
                "value": "ACTIVE",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Aktif"
                    }
                ]
            },
            "indexStatus": {
                "id": 1,
                "value": "ACTIVE",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Aktif"
                    }
                ]
            },
            "fullOverrideExist": null
        }
    }
}

4.9. Endeks Toplu Kayıt Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Not: Tek seferde en fazla 1000 kayıt desteklenmektedir.

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Endeks İşlemleri - Endeks Kaydet
Request 
[
    {
        "consumptionPointId": 200000**4,
        "digitCount": 2,
        "energyType": 1,
        "explanation": "aciklama",
        "factor": 1,
        "firstLoadType": 1,
        "firstReadDate": "2023-08-01T00:00:00+03:00",
        "firstReadType": 1,
        "firstT1": 10,
        "firstT2": 20,
        "firstT3": 30,
        "lastLoadType": 1,
        "lastReadDate": "2023-08-02T00:00:00+03:00",
        "lastReadType": 1,
        "lastT1": 40,
        "lastT2": 50,
        "lastT3": 60,
        "meterBrand": "TEST 1",
        "meterSerialNumber": "12345T",
        "overrideFullOverlap": true,
        "readingOrganizationId": 1010
    },
    {
        "consumptionPointId": 200000**4,
        "digitCount": 2,
        "energyType": 1,
        "explanation": "aciklama",
        "factor": 1,
        "firstLoadType": 1,
        "firstReadDate": "2023-08-02T00:00:00+03:00",
        "firstReadType": 1,
        "firstT1": 10,
        "firstT2": 20,
        "firstT3": 30,
        "lastLoadType": 1,
        "lastReadDate": "2023-08-03T00:00:00+03:00",
        "lastReadType": 1,
        "lastT1": 40,
        "lastT2": 50,
        "lastT3": 60,
        "meterBrand": "TEST 1",
        "meterSerialNumber": "12345T",
        "overrideFullOverlap": true,
        "readingOrganizationId": 1010
    }
]
Response 
{
    "status": "200 OK",
    "correlationId": "c6db6fcc-80d3-403f-9983-c10949ec7f2c",
    "spanIds": "(index-ac)8***7",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": "USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": [
            {
                "indexId": 10000005766,
                "consumptionPointId": 200000**4,
                "firstReadDate": "2023-08-01T00:00:00+03:00",
                "lastReadDate": "2023-08-02T00:00:00+03:00",
                "energyType": 1,
                "isSuccessful": true,
                "errorMessage": null
            },
            {
                "indexId": 10000005749,
                "consumptionPointId": 200000**4,
                "firstReadDate": "2023-08-02T00:00:00+03:00",
                "lastReadDate": "2023-08-03T00:00:00+03:00",
                "energyType": 1,
                "isSuccessful": true,
                "errorMessage": null
            }
        ]
    }
}
Request (XML) 
<IndexSaveRequestWrapperDto>
    <IndexSaveRequestDto>
                <consumptionPointId>200000**4</consumptionPointId>
                <demand />
                <digitCount>2</digitCount>
                <eic>40Z000200000**4H</eic>
                <energyType>1</energyType>
                <explanation>aciklama</explanation>
                <factor>1</factor>
                <firstCapacitive />
                <firstInductive />
                <firstLoadType>0</firstLoadType>
                <firstReadDate>2023-08-30T00:00:00+03:00</firstReadDate>
                <firstReadType>0</firstReadType>
                <firstT1>10</firstT1>
                <firstT2>20</firstT2>
                <firstT3>30</firstT3>
                <lastCapacitive />
                <lastInductive />
                <lastLoadType>0</lastLoadType>
                <lastReadDate>2023-08-31T00:00:00+03:00</lastReadDate>
                <lastReadType>0</lastReadType>
                <lastT1>40</lastT1>
                <lastT2>50</lastT2>
                <lastT3>60</lastT3>
                <meterBrand>TEST 1</meterBrand>
                <meterSerialNumber>12345T</meterSerialNumber>
                <overrideFullOverlap>true</overrideFullOverlap>
                <periodExplanation />
                <readingOrganizationId>1010</readingOrganizationId>
        </IndexSaveRequestDto>
        <IndexSaveRequestDto>
            <consumptionPointId>200000**4</consumptionPointId>
                <demand />
                <digitCount>2</digitCount>
                <eic>40Z000200000**4H</eic>
                <energyType>1</energyType>
                <explanation>aciklama</explanation>
                <factor>1</factor>
                <firstCapacitive />
                <firstInductive />
                <firstLoadType>0</firstLoadType>
                <firstReadDate>2023-08-29T00:00:00+03:00</firstReadDate>
                <firstReadType>0</firstReadType>
                <firstT1>10</firstT1>
                <firstT2>20</firstT2>
                <firstT3>30</firstT3>
                <lastCapacitive />
                <lastInductive />
                <lastLoadType>0</lastLoadType>
                <lastReadDate>2023-08-30T00:00:00+03:00</lastReadDate>
                <lastReadType>0</lastReadType>
                <lastT1>40</lastT1>
                <lastT2>50</lastT2>
                <lastT3>60</lastT3>
                <meterBrand>TEST 1</meterBrand>
                <meterSerialNumber>12345T</meterSerialNumber>
                <overrideFullOverlap>true</overrideFullOverlap>
                <periodExplanation />
                <readingOrganizationId>1010</readingOrganizationId>
        </IndexSaveRequestDto>
</IndexSaveRequestWrapperDto>

4.10. Endeks Güncelleme Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Endeks İşlemleri - Endeks Güncelle
Request 
{
    "factor": "2.0",
    "digitCount": 3,
    "meterSerialNumber": "12345C",
    "meterBrand": "SAYAC MARKA",
    "firstT1": "11.0",
    "firstT2": 21,
    "firstT3": 31,
    "lastT1": 41,
    "lastT2": 51,
    "lastT3": 61,
    "firstInductive": null,
    "lastInductive": null,
    "firstCapacitive": null,
    "lastCapacitive": null,
    "demand": null,
    "firstReadType": 2,
    "lastReadType": 3,
    "firstLoadType": 2,
    "lastLoadType": 2,
    "explanation": "Endeks Guncelleme Aciklama",
    "indexId": 10000005213,
    "periodExplanation": null
}
Response 
{
    "status": "200 OK",
    "correlationId": "c6db6fcc-80d3-403f-9983-c10949ec7f2c",
    "spanIds": "(index-ac)8***7",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": "USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "indexId": 10000005213,
            "version": 3,
            "consumptionPointId": 200000**5,
            "eic": "40Z000200000**54",
            "readingOrganizationId": 1010,
            "meterOwnerOrganizationId": 9082,
            "firstReadDate": "2023-08-04T00:00:00+03:00",
            "lastReadDate": "2023-08-05T00:00:00+03:00",
            "energyType": {
                "id": 1,
                "value": "ACTIVE",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Aktif"
                    }
                ]
            },
            "indexStatus": {
                "id": 1,
                "value": "ACTIVE",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Aktif"
                    }
                ]
            },
            "fullOverrideExist": null
        }
    }
}

4.11. Mevcut Çoklu Seçim Anahtar Sorgulama Servisi

Mevcut çoklu seçim anahtar verilerini sorgular. Servis parametre detaylarına buradan erişebilirsiniz.

Not: Bu servisi çağırabilmek için herhangi bir yetkiye sahip olmak gerekmemektedir.

Yetkiler

N/A

4.12. Çoklu Seçim Detay Sorgulama Servisi

Çoklu seçim detay verilerini sorgular. Servis parametre detaylarına buradan erişebilirsiniz.

Not: Bu servisi çağırabilmek için herhangi bir yetkiye sahip olmak gerekmemektedir.

Yetkiler

N/A

4.13. Okuma Yükümlülük Raporu Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Okuma Yükümlülük Raporu

4.14. Endeks ve Ek Tüketim Özet Raporu Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Not: Bu servisi çağırabilmek için aşağıdaki yetkiye sahip olmak gerekmektedir.

Yetkiler

ST - Endeks ve Ek Tüketim Özet Raporu

5. Dizinler

5.1. Ek Tüketim Pasife Alma Servisi

POST /v1/additional-consumption/passivate

5.1.1. Açıklama

Ek Tüketim verilerini pasife alır.

5.1.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

AdditionalConsumptionPassivateRequestDto

5.1.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseAdditionalConsumptionSummaryDto

5.1.4. Kullanılanlar

  • application/json

  • application/xml

5.1.5. Üretilenler

  • application/json

  • application/xml

5.1.6. Etiketler

  • additionalConsumption

5.2. Ek Tüketim Sorgulama Servisi

POST /v1/additional-consumption/query

5.2.1. Açıklama

Ek Tüketim verilerini sorgular.

5.2.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

AdditionalConsumptionQueryRequestDto

5.2.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSortablePageResponseAdditionalConsumptionQueryResponseDto

5.2.4. Kullanılanlar

  • application/json

  • application/xml

5.2.5. Üretilenler

  • application/json

  • application/xml

5.2.6. Etiketler

  • additionalConsumption

5.3. Ek Tüketim Kayıt Servisi

POST /v1/additional-consumption/save

5.3.1. Açıklama

Ek Tüketim verilerini sisteme kaydeder.

5.3.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

AdditionalConsumptionSaveRequestDto

5.3.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseAdditionalConsumptionSummaryDto

5.3.4. Kullanılanlar

  • application/json

  • application/xml

5.3.5. Üretilenler

  • application/json

  • application/xml

5.3.6. Etiketler

  • additionalConsumption

5.4. Endeks Kayıt Sayısı Sorgulama Servisi

POST /v1/index/count

5.4.1. Açıklama

Endeks kayıt sayısı sorgular.

5.4.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

IndexCountRequestDto

5.4.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseCountResponseDto

5.4.4. Kullanılanlar

  • application/json

  • application/xml

5.4.5. Üretilenler

  • application/json

  • application/xml

5.4.6. Etiketler

  • index

5.5. Endeks Dışa Aktarma Yardımcı Servisi

POST /v1/index/export

5.5.1. Açıklama

Endeks verilerini dışarı aktarma icin yardımcı servis sunar.

5.5.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

IndexExportRequestDto

5.5.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseExportPageResponseIndexQueryResponseDto

5.5.4. Kullanılanlar

  • application/json

  • application/xml

5.5.5. Üretilenler

  • application/json

  • application/xml

5.5.6. Etiketler

  • index

5.6. Endeks Pasife Alma Servisi

POST /v1/index/passivate

5.6.1. Açıklama

Endeks verilerini pasife alır.

5.6.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

IndexPassivateRequestDto

5.6.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseIndexSummaryDto

5.6.4. Kullanılanlar

  • application/json

  • application/xml

5.6.5. Üretilenler

  • application/json

  • application/xml

5.6.6. Etiketler

  • index

5.7. Endeks Sorgulama Servisi

POST /v1/index/query

5.7.1. Açıklama

Endeks verilerini sorgular.

5.7.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

IndexQueryRequestDto

5.7.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSortablePageResponseIndexQueryResponseDto

5.7.4. Kullanılanlar

  • application/json

  • application/xml

5.7.5. Üretilenler

  • application/json

  • application/xml

5.7.6. Etiketler

  • index

5.8. Endeks Kayıt Servisi

POST /v1/index/save

5.8.1. Açıklama

Endeks verilerini sisteme kaydeder.

5.8.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

IndexSaveRequestDto

5.8.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseIndexSummaryDto

5.8.4. Kullanılanlar

  • application/json

  • application/xml

5.8.5. Üretilenler

  • application/json

  • application/xml

5.8.6. Etiketler

  • index

5.9. Endeks Toplu Kayıt Servisi

POST /v1/index/save-batch

5.9.1. Açıklama

Endeks verilerini toplu olarak sisteme kaydeder.

5.9.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

< IndexSaveRequestDto > array

5.9.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseIndexBatchSummaryDto

5.9.4. Kullanılanlar

  • application/json

  • application/xml

5.9.5. Üretilenler

  • application/json

  • application/xml

5.9.6. Etiketler

  • index

5.10. Endeks Güncelleme Servisi

POST /v1/index/update

5.10.1. Açıklama

Endeks verilerini günceller.

5.10.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

IndexUpdateRequestDto

5.10.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseIndexSummaryDto

5.10.4. Kullanılanlar

  • application/json

  • application/xml

5.10.5. Üretilenler

  • application/json

  • application/xml

5.10.6. Etiketler

  • index

5.11. Mevcut Çoklu Seçim Anahtar Sorgulama Servisi

GET /v1/lookup

5.11.1. Açıklama

Mevcut çoklu seçim anahtar verilerini sorgular.

5.11.2. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseLookupTypeResponse

5.11.3. Üretilenler

  • application/json

  • application/xml

5.12. Çoklu Seçim Detay Sorgulama Servisi

POST /v1/lookup/query

5.12.1. Açıklama

Çoklu seçim detay verilerini sorgular.

5.12.2. Parametreler

Tip İsim Şema

Header

accept-language
opsiyonel

string

Body

body
opsiyonel

LookupRequest

5.12.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseLookupResponse

5.12.4. Kullanılanlar

  • application/json

  • application/xml

5.12.5. Üretilenler

  • application/json

  • application/xml

5.13. Okuma Yükümlülük Raporu Sorgulama Servisi

POST /v1/read-obligation/query

5.13.1. Açıklama

Okuma Yükümlülük Raporu verilerini sorgular.

5.13.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

ReadObligationQueryRequestDto

5.13.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSortablePageResponseReadObligationDto

5.13.4. Kullanılanlar

  • application/json

  • application/xml

5.13.5. Üretilenler

  • application/json

  • application/xml

5.13.6. Etiketler

  • readObligation

5.14. Endeks ve Ek Tüketim Özet Raporu Sorgulama Servisi

POST /v1/summary-report/query

5.14.1. Açıklama

Endeks ve Ek Tüketim Özet Raporu verilerini sorgular.

5.14.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

SummaryReportQueryRequestDto

5.14.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSummaryReportQueryResponseDto

5.14.4. Kullanılanlar

  • application/json

  • application/xml

5.14.5. Üretilenler

  • application/json

  • application/xml

5.14.6. Etiketler

  • summaryReport

6. Tanımlar

6.1. AdditionalConsumptionPassivateRequestDto

İsim Açıklama Şema

explanation
gerekli

Açıklama

string

id
gerekli

Ek Tüketim ID

integer (int64)

6.2. AdditionalConsumptionQueryRequestDto

İsim Açıklama Şema

additionalConsumptionReasons
opsiyonel

Ek Tüketim Nedeni

< integer (int64) > array

additionalConsumptionStatuses
opsiyonel

Ek Tüketim Durumu

< integer (int64) > array

consumptionPointId
opsiyonel

Ölçüm Noktası ID

integer (int64)

createDateEndAsPeriod
opsiyonel

İşlem Tarihi - Bitiş

string (date-time)

createDateStartAsPeriod
opsiyonel

İşlem Tarihi - Başlangıç

string (date-time)

eic
opsiyonel

EIC Kod

string

energyTypes
opsiyonel

Enerji Türü

< integer (int64) > array

firstReadDateAsPeriod
opsiyonel

Dönem - Başlangıç

string (date-time)

id
opsiyonel

Ek Tüketim ID

integer (int64)

lastReadDateAsPeriod
opsiyonel

Dönem - Bitiş

string (date-time)

meterOwnerOrganizationId
opsiyonel

Organizasyon ID

integer (int64)

page
opsiyonel

Page

portfolioType
opsiyonel

Portföy Tipi

integer (int64)

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

6.3. AdditionalConsumptionQueryResponseDto

İsim Açıklama Şema

additionalConsumptionReason
opsiyonel

Ek Tüketim Nedeni

LookupDTO

additionalConsumptionStatus
opsiyonel

Ek Tüketim Durumu

LookupDTO

capacitive
opsiyonel

RC (kVarh)

string

consumptionPointId
opsiyonel

Ölçüm Noktası ID

integer (int64)

createDate
opsiyonel

İşlem Tarihi

string (date-time)

createUser
opsiyonel

İşlem Yapan Kullanıcı

string

demand
opsiyonel

Demand

string

eic
opsiyonel

EIC Kod

string

energyType
opsiyonel

Enerji Türü

LookupDTO

explanation
opsiyonel

Açıklama

string

firstReadDate
opsiyonel

Ek Tüketim Başlangıç Tarihi

string (date-time)

id
opsiyonel

Ek Tüketim ID

integer (int64)

inductive
opsiyonel

RI (kVarh)

string

lastReadDate
opsiyonel

Ek Tüketim Bitiş Tarihi

string (date-time)

meterOwnerOrganizationId
opsiyonel

Organizasyon ID

integer (int64)

meterOwnerOrganizationName
opsiyonel

Organizasyon Adı

string

modifyDate
opsiyonel

Güncelleme Tarihi

string (date-time)

modifyUser
opsiyonel

Güncelleme Yapan Kullanıcı

string

period
opsiyonel

Periyot

integer (int64)

portfolioType
opsiyonel

Portföy Tipi

LookupDTO

reactiveOrDemand
opsiyonel

Reaktif (kVarh) / Demand (kW)

string

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

readingOrganizationName
opsiyonel

Sayaç Okuyan Kurum Adı

string

t1
opsiyonel

T1 (kWh)

string

t2
opsiyonel

T2 (kWh)

string

t3
opsiyonel

T3 (kWh)

string

uploadPeriod
opsiyonel

Yükleme Süresi

integer (int64)

6.4. AdditionalConsumptionSaveRequestDto

İsim Açıklama Şema

additionalConsumptionReason
gerekli

Ek Tüketim Nedeni

integer (int64)

capacitive
opsiyonel

RC (kVarh)

number

consumptionPointId
opsiyonel

Ölçüm Noktası ID

integer (int64)

demand
opsiyonel

Demand

number

eic
opsiyonel

EIC Kod

string

energyType
gerekli

Enerji Türü

integer (int64)

explanation
opsiyonel

Açıklama

string

firstReadDate
gerekli

Ek Tüketim Başlangıç Tarihi

string (date-time)

inductive
opsiyonel

RI (kVarh)

number

lastReadDate
gerekli

Ek Tüketim Bitiş Tarihi

string (date-time)

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

t1
opsiyonel

T1 (kWh)

number

t2
opsiyonel

T2 (kWh)

number

t3
opsiyonel

T3 (kWh)

number

6.5. AdditionalConsumptionSummaryDto

İsim Açıklama Şema

additionalConsumptionStatus
opsiyonel

Ek Tüketim Durumu

LookupDTO

consumptionPointId
opsiyonel

Ölçüm Noktası ID

integer (int64)

eic
opsiyonel

EIC Kod

string

energyType
opsiyonel

Enerji Türü

LookupDTO

firstReadDate
opsiyonel

Ek Tüketim Başlangıç Tarihi

string (date-time)

id
opsiyonel

Ek Tüketim ID

integer (int64)

lastReadDate
opsiyonel

Ek Tüketim Bitiş Tarihi

string (date-time)

meterOwnerOrganizationId
opsiyonel

Organizasyon ID

integer (int64)

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

6.6. BaseDTO

Tip : object

6.7. CountResponseDto

İsim Açıklama Şema

count
opsiyonel

Kayıt Sayısı

integer (int64)

6.8. ExportPageResponse

İsim Şema

items
opsiyonel

< object > array

page
opsiyonel

Page

6.9. ExportPageResponseIndexQueryResponseDto

İsim Şema

items
opsiyonel

< IndexQueryResponseDto > array

page
opsiyonel

Page

6.10. IndexBatchSummaryDto

İsim Açıklama Şema

consumptionPointId
opsiyonel

Ölçüm Noktası ID

integer (int64)

energyType
opsiyonel

Enerji Türü

integer (int64)

errorMessage
opsiyonel

Hata Mesajı

string

explanation
opsiyonel

Açıklama

string

firstReadDate
opsiyonel

İlk Okuma Tarihi

string (date-time)

indexId
opsiyonel

Endeks ID

integer (int64)

isSuccessful
opsiyonel

Kayıt Başarılı mı?

boolean

lastReadDate
opsiyonel

Son Okuma Tarihi

string (date-time)

6.11. IndexCountRequestDto

İsim Açıklama Şema

consumptionPointId
opsiyonel

Ölçüm Noktası ID

integer (int64)

createDateEndAsPeriod
opsiyonel

İşlem Tarihi - Bitiş

string (date-time)

createDateStartAsPeriod
opsiyonel

İşlem Tarihi - Başlangıç

string (date-time)

eic
opsiyonel

EIC Kod

string

energyTypes
opsiyonel

Enerji Türü

< integer (int64) > array

firstReadDateAsPeriod
opsiyonel

Dönem - İlk Okuma

string (date-time)

firstReadTypes
opsiyonel

İlk Okuma Türü

< integer (int64) > array

id
opsiyonel

ID (Migrasyon öncesi eşleme)

integer (int64)

indexId
opsiyonel

Endeks ID

integer (int64)

indexStatuses
opsiyonel

Endeks Durum

< integer (int64) > array

lastReadDateAsPeriod
opsiyonel

Dönem - Son Okuma

string (date-time)

lastReadTypes
opsiyonel

Son Okuma Türü

< integer (int64) > array

meterOwnerOrganizationId
opsiyonel

Organizasyon ID

integer (int64)

periodSwitch
opsiyonel

Okuma Periyodu

boolean

portfolioType
opsiyonel

Portföy Tipi

integer (int64)

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

6.12. IndexExportRequestDto

İsim Açıklama Şema

consumptionPointId
opsiyonel

Ölçüm Noktası ID

integer (int64)

createDateEndAsPeriod
opsiyonel

İşlem Tarihi - Bitiş

string (date-time)

createDateStartAsPeriod
opsiyonel

İşlem Tarihi - Başlangıç

string (date-time)

eic
opsiyonel

EIC Kod

string

energyTypes
opsiyonel

Enerji Türü

< integer (int64) > array

firstReadDateAsPeriod
opsiyonel

Dönem - İlk Okuma

string (date-time)

firstReadTypes
opsiyonel

İlk Okuma Türü

< integer (int64) > array

id
opsiyonel

ID (Migrasyon öncesi eşleme)

integer (int64)

indexId
opsiyonel

Endeks ID

integer (int64)

indexStatuses
opsiyonel

Endeks Durum

< integer (int64) > array

lastReadDateAsPeriod
opsiyonel

Dönem - Son Okuma

string (date-time)

lastReadTypes
opsiyonel

Son Okuma Türü

< integer (int64) > array

meterOwnerOrganizationId
opsiyonel

Organizasyon ID

integer (int64)

page
opsiyonel

Sorgulama Sayfası

Page

periodSwitch
opsiyonel

Okuma Periyodu

boolean

portfolioType
opsiyonel

Portföy Tipi

integer (int64)

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

6.13. IndexPassivateRequestDto

İsim Açıklama Şema

explanation
gerekli

Açıklama

string

indexId
gerekli

Endeks ID

integer (int64)

6.14. IndexQueryRequestDto

İsim Açıklama Şema

consumptionPointId
opsiyonel

Ölçüm Noktası ID

integer (int64)

createDateEndAsPeriod
opsiyonel

İşlem Tarihi - Bitiş

string (date-time)

createDateStartAsPeriod
opsiyonel

İşlem Tarihi - Başlangıç

string (date-time)

eic
opsiyonel

EIC Kod

string

energyTypes
opsiyonel

Enerji Türü

< integer (int64) > array

firstReadDateAsPeriod
opsiyonel

Dönem - İlk Okuma

string (date-time)

firstReadTypes
opsiyonel

İlk Okuma Türü

< integer (int64) > array

id
opsiyonel

ID (Migrasyon öncesi eşleme)

integer (int64)

indexId
opsiyonel

Endeks ID

integer (int64)

indexStatuses
opsiyonel

Endeks Durum

< integer (int64) > array

lastReadDateAsPeriod
opsiyonel

Dönem - Son Okuma

string (date-time)

lastReadTypes
opsiyonel

Son Okuma Türü

< integer (int64) > array

meterOwnerOrganizationId
opsiyonel

Organizasyon ID

integer (int64)

page
opsiyonel

Sorgulama Sayfası

Page

periodSwitch
opsiyonel

Okuma Periyodu

boolean

portfolioType
opsiyonel

Portföy Tipi

integer (int64)

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

6.15. IndexQueryResponseDto

İsim Açıklama Şema

consumptionPointId
opsiyonel

Ölçüm Noktası ID

integer (int64)

createDate
opsiyonel

İşlem Tarihi

string (date-time)

createUser
opsiyonel

Kullanıcı Adı

string

demand
opsiyonel

Demand

string

digitCount
opsiyonel

Hane Sayısı

integer (int64)

eic
opsiyonel

EIC Kod

string

energyType
opsiyonel

Enerji Türü

LookupDTO

explanation
opsiyonel

Açıklama

string

factor
opsiyonel

Çarpan Değeri

number

firstCapacitive
opsiyonel

RC İlk

string

firstInductive
opsiyonel

RI İlk

string

firstLoadType
opsiyonel

İlk Yükleme Türü

LookupDTO

firstReactiveOrDemand
opsiyonel

Reaktif İlk / Demand

string

firstReadDate
opsiyonel

İlk Okuma Tarihi

string (date-time)

firstReadType
opsiyonel

İlk Okuma Türü

LookupDTO

firstT1
opsiyonel

T1 İlk

string

firstT2
opsiyonel

T2 İlk

string

firstT3
opsiyonel

T3 İlk

string

id
opsiyonel

ID (Migrasyon öncesi eşleme)

integer (int64)

indexId
opsiyonel

Endeks ID

integer (int64)

indexStatus
opsiyonel

Endeks Durum

LookupDTO

lastCapacitive
opsiyonel

RC Son

string

lastInductive
opsiyonel

RI Son

string

lastLoadType
opsiyonel

Son Yükleme Türü

LookupDTO

lastReactive
opsiyonel

Reaktif Son

string

lastReadDate
opsiyonel

Son Okuma Tarihi

string (date-time)

lastReadType
opsiyonel

Son Okuma Türü

LookupDTO

lastT1
opsiyonel

T1 Son

string

lastT2
opsiyonel

T2 Son

string

lastT3
opsiyonel

T3 Son

string

meterBrand
opsiyonel

Sayaç Marka

string

meterOwnerOrganizationId
opsiyonel

Organizasyon ID

integer (int64)

meterOwnerOrganizationName
opsiyonel

Organizasyon Adı

string

meterSerialNumber
opsiyonel

Sayaç Seri No

string

period
opsiyonel

Okuma Periyodu

integer (int64)

periodExplanation
opsiyonel

Periyot Açıklama

LookupDTO

portfolioType
opsiyonel

Portföy Tipi

LookupDTO

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

readingOrganizationName
opsiyonel

Sayaç Okuyan Kurum Adı

string

uploadPeriod
opsiyonel

Yükleme Süresi

integer (int64)

version
opsiyonel

Versiyon

integer (int64)

6.16. IndexSaveRequestDto

İsim Açıklama Şema

consumptionPointId
opsiyonel

Ölçüm Noktası ID

integer (int64)

demand
opsiyonel

Demand

number

digitCount
opsiyonel

Hane Sayısı

integer (int64)

eic
opsiyonel

EIC Kod

string

energyType
opsiyonel

Enerji Türü

integer (int64)

explanation
opsiyonel

Açıklama

string

factor
opsiyonel

Çarpan Değeri

number

firstCapacitive
opsiyonel

RC İlk

number

firstInductive
opsiyonel

RI İlk

number

firstLoadType
opsiyonel

İlk Yükleme Türü

integer (int64)

firstReadDate
opsiyonel

İlk Okuma Tarihi

string (date-time)

firstReadType
opsiyonel

İlk Okuma Türü

integer (int64)

firstT1
opsiyonel

T1 İlk

number

firstT2
opsiyonel

T2 İlk

number

firstT3
opsiyonel

T3 İlk

number

lastCapacitive
opsiyonel

RC Son

number

lastInductive
opsiyonel

RI Son

number

lastLoadType
opsiyonel

Son Yükleme Türü

integer (int64)

lastReadDate
opsiyonel

Son Okuma Tarihi

string (date-time)

lastReadType
opsiyonel

Son Okuma Türü

integer (int64)

lastT1
opsiyonel

T1 Son

number

lastT2
opsiyonel

T2 Son

number

lastT3
opsiyonel

T3 Son

number

meterBrand
opsiyonel

Sayaç Marka

string

meterSerialNumber
opsiyonel

Sayaç Seri No

string

overrideFullOverlap
opsiyonel

Tam Çakışma Kaydetme

boolean

periodExplanation
opsiyonel

Periyot Açıklama

integer (int64)

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

6.17. IndexSummaryDto

İsim Açıklama Şema

consumptionPointId
opsiyonel

Ölçüm Noktası ID

integer (int64)

eic
opsiyonel

EIC Kod

string

energyType
opsiyonel

Enerji Türü

LookupDTO

explanation
opsiyonel

Açıklama

string

firstReadDate
opsiyonel

İlk Okuma Tarihi

string (date-time)

fullOverrideExist
opsiyonel

Tam Çakışma Mevcut

boolean

indexId
opsiyonel

Endeks ID

integer (int64)

indexStatus
opsiyonel

Endeks Durum

LookupDTO

lastReadDate
opsiyonel

Son Okuma Tarihi

string (date-time)

meterOwnerOrganizationId
opsiyonel

Organizasyon ID

integer (int64)

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

version
opsiyonel

Versiyon

integer (int64)

6.18. IndexUpdateRequestDto

İsim Açıklama Şema

demand
opsiyonel

Demand

number

digitCount
opsiyonel

Hane Sayısı

integer (int64)

explanation
opsiyonel

Açıklama

string

factor
opsiyonel

Çarpan Değeri

number

firstCapacitive
opsiyonel

RC İlk

number

firstInductive
opsiyonel

RI İlk

number

firstLoadType
opsiyonel

İlk Yükleme Türü

integer (int64)

firstReadType
opsiyonel

İlk Okuma Türü

integer (int64)

firstT1
opsiyonel

T1 İlk

number

firstT2
opsiyonel

T2 İlk

number

firstT3
opsiyonel

T3 İlk

number

indexId
opsiyonel

Endeks ID

integer (int64)

lastCapacitive
opsiyonel

RC Son

number

lastInductive
opsiyonel

RI Son

number

lastLoadType
opsiyonel

Son Yükleme Türü

integer (int64)

lastReadType
opsiyonel

Son Okuma Türü

integer (int64)

lastT1
opsiyonel

T1 Son

number

lastT2
opsiyonel

T2 Son

number

lastT3
opsiyonel

T3 Son

number

meterBrand
opsiyonel

Sayaç Marka

string

meterSerialNumber
opsiyonel

Sayaç Seri No

string

periodExplanation
opsiyonel

Periyot Açıklama

integer (int64)

6.19. LocalizationDTO

İsim Açıklama Şema

language
opsiyonel

Çoklu Seçim Dili

string

text
opsiyonel

Çoklu Seçim Açıklama (Dile Göre)

string

6.20. LookupDTO

İsim Açıklama Şema

id
opsiyonel

Çoklu Seçim ID

integer (int64)

localizations
opsiyonel

Çoklu Seçim Yerelleştirme Listesi

< LocalizationDTO > array

value
opsiyonel

Çoklu Seçim Değer

string

6.21. LookupRequest

İsim Açıklama Şema

lookupType
gerekli

Çoklu Seçim Anahtarı

string

6.22. LookupResponse

İsim Açıklama Şema

values
opsiyonel

Çoklu Seçim Değer Listesi

< LookupDTO > array

6.23. LookupTypeDTO

İsim Açıklama Şema

lookupDescription
opsiyonel

Çoklu Seçim Anahtar Açıklama

string

lookupType
opsiyonel

Çoklu Seçim Anahtarı

string

6.24. LookupTypeResponse

İsim Açıklama Şema

types
opsiyonel

Çoklu Seçim Anahtar Listesi

< LookupTypeDTO > array

6.25. Page

İsim Açıklama Şema

number
opsiyonel

${VALUE_PAGE_NUMBER}
Örnek : "${EXAMPLE_PAGE_NUMBER}"

integer (int64)

size
opsiyonel

${VALUE_PAGE_SIZE}
Örnek : "${EXAMPLE_PAGE_SIZE}"

integer (int64)

sort
opsiyonel

${VALUE_PAGE_SORT}

SortDTO

total
opsiyonel

${VALUE_PAGE_TOTAL}
Örnek : "${EXAMPLE_PAGE_TOTAL}"

integer (int64)

6.26. ReadObligationDto

İsim Açıklama Şema

effectiveId
opsiyonel

Sayaç ID

integer (int64)

eic
opsiyonel

EIC Kod

string

indexAcData
opsiyonel

Endeks / Ek Tüketim Verisi

boolean

meterId
opsiyonel

Sayaç ID

integer (int64)

organizationId
opsiyonel

Tedarikçi Organizasyon ID

integer (int64)

organizationName
opsiyonel

Tedarikçi Organizasyon Adı

string

period
opsiyonel

Dönem

string (date-time)

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

readingOrganizationName
opsiyonel

Sayaç Okuyan Kurum Adı

string

reconciliationData
opsiyonel

Uzlaştırma Verisi

boolean

uniqueCode
opsiyonel

Tekil Kod

string

6.27. ReadObligationQueryRequestDto

İsim Açıklama Şema

effectiveId
opsiyonel

Sayaç ID

integer (int64)

eic
opsiyonel

EIC Kod

string

excludeHighReadPeriod
opsiyonel

Yüksek Okuma Periyotlular Hariç

boolean

organizationId
opsiyonel

Tedarikçi Organizasyon ID

integer (int64)

page
opsiyonel

Page

period
opsiyonel

Dönem

string (date-time)

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

uniqueCode
opsiyonel

Tekil Kod

string

6.28. RestResponse

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodyObject

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.29. RestResponseAdditionalConsumptionSummaryDto

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodyAdditionalConsumptionSummaryDto

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.30. RestResponseBody

İsim Şema

content
opsiyonel
sadece okuma

object

6.31. RestResponseBodyAdditionalConsumptionSummaryDto

İsim Şema

content
opsiyonel
sadece okuma

AdditionalConsumptionSummaryDto

6.32. RestResponseBodyCountResponseDto

İsim Şema

content
opsiyonel
sadece okuma

CountResponseDto

6.33. RestResponseBodyExportPageResponseIndexQueryResponseDto

İsim Şema

content
opsiyonel
sadece okuma

ExportPageResponseIndexQueryResponseDto

6.34. RestResponseBodyIndexBatchSummaryDto

İsim Şema

content
opsiyonel
sadece okuma

IndexBatchSummaryDto

6.35. RestResponseBodyIndexSummaryDto

İsim Şema

content
opsiyonel
sadece okuma

IndexSummaryDto

6.36. RestResponseBodyLookupResponse

İsim Şema

content
opsiyonel
sadece okuma

LookupResponse

6.37. RestResponseBodyLookupTypeResponse

İsim Şema

content
opsiyonel
sadece okuma

LookupTypeResponse

6.38. RestResponseBodyObject

İsim Şema

content
opsiyonel
sadece okuma

object

6.39. RestResponseBodySortablePageResponseAdditionalConsumptionQueryResponseDto

İsim Şema

content
opsiyonel
sadece okuma

SortablePageResponseAdditionalConsumptionQueryResponseDto

6.40. RestResponseBodySortablePageResponseIndexQueryResponseDto

İsim Şema

content
opsiyonel
sadece okuma

SortablePageResponseIndexQueryResponseDto

6.41. RestResponseBodySortablePageResponseReadObligationDto

İsim Şema

content
opsiyonel
sadece okuma

SortablePageResponseReadObligationDto

6.42. RestResponseBodySummaryReportQueryResponseDto

İsim Şema

content
opsiyonel
sadece okuma

SummaryReportQueryResponseDto

6.43. RestResponseCountResponseDto

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodyCountResponseDto

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.44. RestResponseError

İsim Açıklama Şema

errorCode
opsiyonel

Alınan hatanın kod bilgisi

string

errorMessage
opsiyonel

Alınan hatanın açıklaması

string

6.45. RestResponseExportPageResponseIndexQueryResponseDto

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodyExportPageResponseIndexQueryResponseDto

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.46. RestResponseIndexBatchSummaryDto

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodyIndexBatchSummaryDto

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.47. RestResponseIndexSummaryDto

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodyIndexSummaryDto

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.48. RestResponseLookupResponse

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodyLookupResponse

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.49. RestResponseLookupTypeResponse

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodyLookupTypeResponse

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.50. RestResponseSortablePageResponseAdditionalConsumptionQueryResponseDto

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodySortablePageResponseAdditionalConsumptionQueryResponseDto

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.51. RestResponseSortablePageResponseIndexQueryResponseDto

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodySortablePageResponseIndexQueryResponseDto

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.52. RestResponseSortablePageResponseReadObligationDto

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodySortablePageResponseReadObligationDto

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.53. RestResponseSummaryReportQueryResponseDto

İsim Açıklama Şema

body
opsiyonel

Yapılan istek başarılı olması durumunda çağırılan servisin cevabıdır. İstekler başarısız ise bu alan boş gelecektir.

RestResponseBodySummaryReportQueryResponseDto

clientIp
opsiyonel

İsteği yapan istemcinin IP bilgisi

string

correlationId
opsiyonel

Yapmış olduğunuz isteği tekilleştirmeye yarar. Hata almanız durumunda bu bilgiyi göndermeniz zorunludur.

string

dispatch
opsiyonel

string

errors
opsiyonel

Başarılı durumda liste boş dönmektedir. Hata almanız durumunda liste içinde aldığınız hatanın hata kodu ve hata mesajlarını dönmektedir. Hatalar ile ilgili detaylı bilgi almak isterseniz bu değerleri göndermeniz gerekmektedir.

< RestResponseError > array

hostName
opsiyonel

string

spanIds
opsiyonel

string

status
opsiyonel

Yapılan isteğin HTTP durum kodunu dönmektedir.

string

successMessage
opsiyonel

string

unsuccessfulList
opsiyonel

Yapılan istekte hatalı olan ve sisteme kaydedilmeyen kayıtların listesini dönmektedir.

< BaseDTO > array

userName
opsiyonel

İsteği yapan kullanıcı bilgisi

string

6.54. SortDTO

İsim Açıklama Şema

direction
opsiyonel

${VALUE_SORT_DIRECTION}
Örnek : "ASC"

enum (ASC, DESC)

field
opsiyonel

${VALUE_SORT_FIELD}
Örnek : "${EXAMPLE_SORT_FIELD}"

string

6.55. SortablePageResponse

İsim Şema

items
opsiyonel

< object > array

page
opsiyonel

Page

sortableFields
opsiyonel

< string > array

6.56. SortablePageResponseAdditionalConsumptionQueryResponseDto

İsim Şema

items
opsiyonel

< AdditionalConsumptionQueryResponseDto > array

page
opsiyonel

Page

sortableFields
opsiyonel

< string > array

6.57. SortablePageResponseIndexQueryResponseDto

İsim Şema

items
opsiyonel

< IndexQueryResponseDto > array

page
opsiyonel

Page

sortableFields
opsiyonel

< string > array

6.58. SortablePageResponseReadObligationDto

İsim Şema

items
opsiyonel

< ReadObligationDto > array

page
opsiyonel

Page

sortableFields
opsiyonel

< string > array

6.59. SummaryDurationReportDto

İsim Açıklama Şema

extremelyLate
opsiyonel

Çok Geç Yükleme

integer (int64)

late
opsiyonel

Geç Yükleme

integer (int64)

normal
opsiyonel

Zamanında Yükleme

integer (int64)

total
opsiyonel

Toplam

integer (int64)

6.60. SummaryReportQueryRequestDto

İsim Açıklama Şema

excludeHighReadPeriod
opsiyonel

Yüksek Okuma Periyotlular Hariç

boolean

organizationId
opsiyonel

Organizasyon ID

integer (int64)

period
opsiyonel

Dönem

string (date-time)

readingOrganizationId
opsiyonel

Sayaç Okuyan Kurum ID

integer (int64)

6.61. SummaryReportQueryResponseDto

İsim Şema

durations
opsiyonel

SummaryDurationReportDto

states
opsiyonel

SummaryStateReportDto

6.62. SummaryStateReportDto

İsim Açıklama Şema

bothExisting
opsiyonel

Endeks ve Uzlaştırma Verisi Yüklenenler

integer (int64)

bothNonExisting
opsiyonel

Endeks ve Uzlaştırma Verisi Yüklenmeyenler

integer (int64)

onlyIndexAcExisting
opsiyonel

Sadece Endeks Verisi Yüklenenler

integer (int64)

onlyReconciliationExisting
opsiyonel

Sadece Uzlaştırma Verisi Yüklenenler

integer (int64)

total
opsiyonel

Toplam

integer (int64)

totalIndexAcExisting
opsiyonel

Toplam Endeks Verisi Yüklenenler

integer (int64)

totalIndexAcNonExisting
opsiyonel

Toplam Endeks Verisi Yüklenmeyenler

integer (int64)

totalReconciliationExisting
opsiyonel

Toplam Uzlaştırma Verisi Yüklenenler

integer (int64)

totalReconciliationNonExisting
opsiyonel

Toplam Uzlaştırma Verisi Yüklenmeyenler

integer (int64)