Genel Bakış

Versiyon bilgisi

Versiyon : 1.0.0

URI şeması

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

Etiketler

  • market-participation

  • organization

  • power-plant

  • settlement-aggregation-entity

Doküman Hakkında

Bu dokümanda Kayıt servislerinin tanımları ve bu servislerin nasıl çağrılacağı anlatılmaktadır.

1. EPYS Kayıt Servisleri Hakkında

EPYS Kayıt 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/registration/technical/swagger.json gerçek ortam için https://epys.epias.com.tr/registration/technical/swagger.json dosyasını kullanarak https://generator.swagger.io adresinden kullandığınız dile uygun istemci kodlarını oluşturabilirsiniz.

3. EPYS Kayıt 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 Kayıt 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 hatakodu 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.Bizimle 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. 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.2. Ç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.3. Piyasa Katılımı Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar

Piyasa Katılımcısı

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

Yetkiler

Kayıt - Piyasa Katılım Bilgisi Sorgula Okuma Yetkisi

4.4. Piyasa Katılımı Güncelleme Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

K1 - Görevli Tedarik Şirketi

K2 - Görevli Tedarik Şirketi

K3 - Görevli Tedarik Şirketi

Tedarik

ÜRETİM

OSB - ÜRETİM

PK - DAĞITIM

PK - İLETİM

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

Yetkiler

Kayıt - Piyasa Aktivasyon İşlemleri - Piyasa Aktivasyon Yap

4.5. Organizasyon Tüm Detay Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Şarj Ağı İşletmecisi

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

Yetkiler

Kayıt - Online Kayıt Listeleme - Organizasyon Bilgileri Detay Görüntüle

4.6. Aktif Organizasyonlar Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Şarj Ağı İşletmecisi

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

Yetkiler

Kayıt - Online Kayıt Listeleme - Organizasyon Bilgileri Listele

4.7. Ana Organizasyonlar Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Şarj Ağı İşletmecisi

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

Yetkiler

Kayıt - Online Kayıt Listeleme - Organizasyon Bilgileri Listele

4.8. Organizasyon GÖP Katılımı Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Şarj Ağı İşletmecisi

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

Yetkiler

Kayıt - Online Kayıt Listeleme - Organizasyon Bilgileri Listele

4.9. Tekil Organizasyon Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Şarj Ağı İşletmecisi

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

Yetkiler

Kayıt - Online Kayıt Listeleme - Organizasyon Bilgileri Listele

4.10. Organizasyonun Bulunduğu İller Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Şarj Ağı İşletmecisi

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

Yetkiler

Kayıt - Online Kayıt Listeleme - Organizasyon Bilgileri Listele

4.11. Organizasyon Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Şarj Ağı İşletmecisi

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

Yetkiler

Kayıt - Online Kayıt Listeleme - Organizasyon Bilgileri Listele

4.12. Organizasyon Özet Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Şarj Ağı İşletmecisi

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

Yetkiler

Kayıt - Online Kayıt Listeleme - Organizasyon Bilgileri Listele

4.13. Organizasyon Detay Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

Sayaç Okuyan Kurum

Şarj Ağı İşletmecisi

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

Yetkiler

Kayıt - Online Kayıt Listeleme - Organizasyon Bilgileri Listele

4.14. Santral Bölge Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Piyasa Katılımcısı

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

Yetkiler

Kayıt - Santral Listeleme - Santral Listesi Görüntüle

4.15. Santral Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

K3 - Görevli Tedarik Şirketi

ÜRETİM

OSB - ÜRETİM

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

Yetkiler

Kayıt - Santral Listeleme - Santral Listesi Görüntüle

4.16. UEVÇB Detay Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

K1 - Görevli Tedarik Şirketi

K2 - Görevli Tedarik Şirketi

K3 - Görevli Tedarik Şirketi

Tedarik

ÜRETİM

OSB - ÜRETİM

PK - DAĞITIM

PK - İLETİM

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

Yetkiler

Kayıt - UEVÇB Listeleme - UEVÇB Detay Görüntüle

4.17. UEVÇB Sorgulama Servisi

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

K1 - Görevli Tedarik Şirketi

K2 - Görevli Tedarik Şirketi

K3 - Görevli Tedarik Şirketi

Tedarik

ÜRETİM

OSB - ÜRETİM

PK - DAĞITIM

PK - İLETİM

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

Yetkiler

Kayıt - UEVÇB Listeleme - UEVÇB Listesi Görüntüle

5. Dizinler

5.1. Mevcut Çoklu Seçim Anahtar Sorgulama Servisi

GET /v1/lookup

5.1.1. Açıklama

Mevcut çoklu seçim anahtar verilerini sorgular.

5.1.2. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseLookupTypeResponse

5.1.3. Üretilenler

  • application/json

  • application/xml

5.2. Çoklu Seçim Detay Sorgulama Servisi

POST /v1/lookup/query

5.2.1. Açıklama

Çoklu seçim detay verilerini sorgular.

5.2.2. Parametreler

Tip İsim Şema

Header

accept-language
opsiyonel

string

Body

body
opsiyonel

LookupRequest

5.2.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseLookupResponse

5.2.4. Kullanılanlar

  • application/json

  • application/xml

5.2.5. Üretilenler

  • application/json

  • application/xml

5.3. Piyasa Katılımı Sorgulama Servisi

POST /v1/market-participation/query

5.3.1. Açıklama

Sorgulama yapmak istediğiniz piyasa katılımı bilgilerini bu servis ile alabilirsiniz.

5.3.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

MarketParticipationQueryRequestDto

5.3.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSortablePageResponseMarketParticipationDto

5.3.4. Kullanılanlar

  • application/json

  • application/xml

5.3.5. Üretilenler

  • application/json

  • application/xml

5.3.6. Etiketler

  • market-participation

5.4. Piyasa Katılımı Güncelleme Servisi

POST /v1/market-participation/update

5.4.1. Açıklama

Güncelleme yapmak istediğiniz piyasa katılımı bilgilerini bu servis ile alabilirsiniz.

5.4.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

MarketParticipationUpdateRequestDto

5.4.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseMarketParticipationDto

5.4.4. Kullanılanlar

  • application/json

  • application/xml

5.4.5. Üretilenler

  • application/json

  • application/xml

5.4.6. Etiketler

  • market-participation

5.5. Organizasyon Tüm Detay Sorgulama Servisi

GET /v1/organization/cascade/{effectiveId}

5.5.1. Açıklama

Sorgulama yapmak istediğiniz organizasyon tüm detay bilgilerini bu servis ile alabilirsiniz.

5.5.2. Parametreler

Tip İsim Açıklama Şema

Path

effectiveId
gerekli

Organizasyonun ID bilgisi

integer (int64)

5.5.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseOrganizationCascadeDto

5.5.4. Üretilenler

  • application/json

  • application/xml

5.5.5. Etiketler

  • organization

5.6. Aktif Organizasyonlar Sorgulama Servisi

POST /v1/organization/fetch-active-organizations

5.6.1. Açıklama

Sorgulama yapmak istediğiniz aktif organizasyon bilgilerini bu servis ile alabilirsiniz.

5.6.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

OrganizationListFetchDto

5.6.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseLabelValueSubTypeDto

5.6.4. Kullanılanlar

  • application/json

  • application/xml

5.6.5. Üretilenler

  • application/json

  • application/xml

5.6.6. Etiketler

  • organization

5.7. Ana Organizasyonlar Sorgulama Servisi

GET /v1/organization/fetch-main-organizations

5.7.1. Açıklama

Sorgulama yapmak istediğiniz ana organizasyon bilgilerini bu servis ile alabilirsiniz.

5.7.2. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseLabelValueDTO

5.7.3. Üretilenler

  • application/json

  • application/xml

5.7.4. Etiketler

  • organization

5.8. Organizasyon GÖP Katılımı Sorgulama Servisi

POST /v1/organization/fetch-organizations-with-dam-participation

5.8.1. Açıklama

Sorgulama yapmak istediğiniz organizasyon piyasa katılımı bilgilerini bu servis ile alabilirsiniz.

5.8.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

OrganizationWithDamParticipationQueryRequestDto

5.8.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseOrganizationWithDamParticipationQueryResponseDto

5.8.4. Kullanılanlar

  • application/json

  • application/xml

5.8.5. Üretilenler

  • application/json

  • application/xml

5.8.6. Etiketler

  • organization

5.9. POST /v1/organization/fetch-organizations-with-licenses

5.9.1. Parametreler

Tip İsim Şema

Body

body
opsiyonel

OrganizationListFetchDto

5.9.2. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseOrganizationsWithLicensesDto

5.9.3. Kullanılanlar

  • application/json

  • application/xml

5.9.4. Üretilenler

  • application/json

  • application/xml

5.9.5. Etiketler

  • organization

5.10. Tekil Organizasyon Sorgulama Servisi

POST /v1/organization/fetch-single-organization

5.10.1. Açıklama

Sorgulama yapmak istediğiniz tekil organizasyon bilgilerini bu servis ile alabilirsiniz.

5.10.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

OrganizationFetchDto

5.10.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseOrganizationDto

5.10.4. Kullanılanlar

  • application/json

  • application/xml

5.10.5. Üretilenler

  • application/json

  • application/xml

5.10.6. Etiketler

  • organization

5.11. Organizasyon Özet Sorgulama Servisi

POST /v1/organization/fetch-summary

5.11.1. Açıklama

Sorgulama yapmak istediğiniz organizasyon özet bilgilerini bu servis ile alabilirsiniz.

5.11.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

OrganizationFetchDto

5.11.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseOrganizationSummaryDto

5.11.4. Kullanılanlar

  • application/json

  • application/xml

5.11.5. Üretilenler

  • application/json

  • application/xml

5.11.6. Etiketler

  • organization

5.12. Organizasyonun Bulunduğu İller Sorgulama Servisi

GET /v1/organization/provinces/{effectiveId}

5.12.1. Açıklama

Sorgulama yapmak istediğiniz organizasyonun bulunduğu İller bilgilerini bu servis ile alabilirsiniz.

5.12.2. Parametreler

Tip İsim Açıklama Şema

Header

accept-language
opsiyonel

string

Path

effectiveId
gerekli

Organizasyonun ID bilgisi

integer (int64)

5.12.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseProvinceDto

5.12.4. Üretilenler

  • application/json

  • application/xml

5.12.5. Etiketler

  • organization

5.13. Organizasyon Sorgulama Servisi

POST /v1/organization/query

5.13.1. Açıklama

Sorgulama yapmak istediğiniz organizasyon bilgilerini bu servis ile alabilirsiniz.

5.13.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

OrganizationQueryRequestDto

5.13.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSortablePageResponseOrganizationQueryResponseDto

5.13.4. Kullanılanlar

  • application/json

  • application/xml

5.13.5. Üretilenler

  • application/json

  • application/xml

5.13.6. Etiketler

  • organization

5.14. Organizasyon Detay Sorgulama Servisi

GET /v1/organization/{effectiveId}

5.14.1. Açıklama

Sorgulama yapmak istediğiniz organizasyon detay bilgilerini bu servis ile alabilirsiniz.

5.14.2. Parametreler

Tip İsim Açıklama Şema

Path

effectiveId
gerekli

Organizasyonun ID bilgisi

integer (int64)

5.14.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseOrganizationDto

5.14.4. Üretilenler

  • application/json

  • application/xml

5.14.5. Etiketler

  • organization

5.15. Santral Bölge Sorgulama Servisi

POST /v1/power-plant/fetch-regions

5.15.1. Açıklama

Sorgulama yapmak istediğiniz santral bölge bilgilerini bu servis ile alabilirsiniz.

5.15.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

PowerPlantRegionQueryRequestDto

5.15.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseRegionDto

5.15.4. Kullanılanlar

  • application/json

  • application/xml

5.15.5. Üretilenler

  • application/json

  • application/xml

5.15.6. Etiketler

  • power-plant

5.16. Santral Sorgulama Servisi

POST /v1/power-plant/query

5.16.1. Açıklama

Sorgulama yapmak istediğiniz santral bilgilerini bu servis ile alabilirsiniz.

5.16.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

PowerPlantQueryRequestDto

5.16.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSortablePageResponsePowerPlantQueryResponseDto

5.16.4. Kullanılanlar

  • application/json

  • application/xml

5.16.5. Üretilenler

  • application/json

  • application/xml

5.16.6. Etiketler

  • power-plant

5.17. UEVÇB Detay Sorgulama Servisi

POST /v1/sae/detail

5.17.1. Açıklama

Sorgulama yapmak istediğiniz UEVÇB detay bilgilerini bu servis ile alabilirsiniz.

5.17.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

SaeGetDetailRequestDto

5.17.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSaeDto

5.17.4. Kullanılanlar

  • application/json

  • application/xml

5.17.5. Üretilenler

  • application/json

  • application/xml

5.17.6. Etiketler

  • settlement-aggregation-entity

5.18. UEVÇB Sorgulama Servisi

POST /v1/sae/query

5.18.1. Açıklama

Sorgulama yapmak istediğiniz UEVÇB bilgilerini bu servis ile alabilirsiniz.

5.18.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

SaeQueryRequestDto

5.18.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSortablePageResponseSaeQueryResponseDto

5.18.4. Kullanılanlar

  • application/json

  • application/xml

5.18.5. Üretilenler

  • application/json

  • application/xml

5.18.6. Etiketler

  • settlement-aggregation-entity

6. Tanımlar

6.1. BaseDTO

Tip : object

6.2. DescriptionDto

İsim Açıklama Şema

description
gerekli

Tanım

string

language
gerekli

Dil

string

6.3. LabelValueDTO

İsim Şema

label
opsiyonel

string

value
opsiyonel

string

6.4. LabelValueSubTypeDto

İsim Açıklama Şema

label
opsiyonel

Etiket

string

subType
opsiyonel

Alt Tip

LookupDTO

value
opsiyonel

Değer

string

6.5. Localization

İsim Şema

id
opsiyonel

LocalizationPK

text
opsiyonel

string

6.6. LocalizationDTO

İsim Açıklama Şema

language
opsiyonel

Çoklu Seçim Dili

string

text
opsiyonel

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

string

6.7. LocalizationPK

İsim Şema

language
opsiyonel

string

localizationId
opsiyonel

integer (int64)

6.8. 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.9. LookupRequest

İsim Açıklama Şema

lookupType
gerekli

Çoklu Seçim Anahtarı

string

6.10. LookupResponse

İsim Açıklama Şema

values
opsiyonel

Çoklu Seçim Değer Listesi

< LookupDTO > array

6.11. LookupTypeDTO

İsim Açıklama Şema

lookupDescription
opsiyonel

Çoklu Seçim Anahtar Açıklama

string

lookupType
opsiyonel

Çoklu Seçim Anahtarı

string

6.12. LookupTypeResponse

İsim Açıklama Şema

types
opsiyonel

Çoklu Seçim Anahtar Listesi

< LookupTypeDTO > array

6.13. MarketParticipationDto

İsim Açıklama Şema

effectiveDateEnd
opsiyonel

Geçerlilik Tarihi Bitiş

string (date-time)

effectiveDateStart
opsiyonel

Geçerlilik Tarihi Başlangıç

string (date-time)

id
opsiyonel

ID

integer (int64)

marketType
opsiyonel

Piyasa Tipi

LookupDTO

organizationEid
opsiyonel

Organizasyon ID’si

integer (int64)

organizationName
opsiyonel

Organizasyon Adı

string

participationStatus
opsiyonel

Katılım Durumu

LookupDTO

6.14. MarketParticipationQueryRequestDto

İsim Açıklama Şema

effectiveDate
opsiyonel

Geçerlilik Tarihi

string (date-time)

marketTypeIds
opsiyonel

Piyasa Tipi ID’leri

< integer (int64) > array

organizationEffectiveId
opsiyonel

Organizasyon ID’si

integer (int64)

page
opsiyonel

Page

status
opsiyonel

Durum

< integer (int64) > array

6.15. MarketParticipationUpdateRequestDto

İsim Açıklama Şema

descriptions
gerekli

Açıklamalar

< DescriptionDto > array

effectiveDate
opsiyonel

Geçerlilik Tarihi

string (date-time)

marketTypeId
opsiyonel

Piyasa Tipi ID

integer (int64)

organizationEffectiveId
gerekli

Organizasyon ID’si

integer (int64)

status
opsiyonel

Durum

integer (int64)

6.16. NameBreakdownResponseDto

İsim Açıklama Şema

display
opsiyonel

boolean

effectiveDateEnd
opsiyonel

Geçerlilik Tarihi Bitiş

string (date-time)

effectiveDateStart
opsiyonel

Geçerlilik Tarihi Başlangıç

string (date-time)

effectiveId
opsiyonel

ID

integer (int64)

eic
opsiyonel

ETSO Kodu

string

name
opsiyonel

Ad

string

6.17. OrganizationAdminInformationResponseDto

İsim Açıklama Şema

adminEmail
opsiyonel

Yetkili E-Posta

string

adminName
opsiyonel

Yetkili Adı

string

adminPhone
opsiyonel

Yetkili Telefonu

string

adminSurname
opsiyonel

Yetkili Soyadı

string

adminUsername
opsiyonel

Admin Kullanıcı Adı

string

tcIdentifier
opsiyonel

TC Kimlik No

string

6.18. OrganizationCascadeDto

İsim Açıklama Şema

organization
opsiyonel

Organizasyon

OrganizationDto

organizationAdminInformation
opsiyonel

Organizasyon Yetkili Bilgileri

OrganizationAdminInformationResponseDto

organizationContactInformation
opsiyonel

Organizasyon İletişim Bilgileri

OrganizationContactInformationDto

organizationDocumentInformation
opsiyonel

Organizasyon Belgeleri

OrganizationDocumentInformationDto

organizationLicenseInformationList
opsiyonel

Organizasyon Lisans Bilgileri

< OrganizationLicenseInformationDto > array

organizationPfmInformation
opsiyonel

Organizasyon VEP Bilgileri

OrganizationPfmInformationDto

organizationTaxInformation
opsiyonel

Organizasyon Vergi Bilgileri

OrganizationTaxInformationDto

6.19. OrganizationContactInformationDto

İsim Açıklama Şema

address
opsiyonel

Adres

string

districtId
opsiyonel

İlçe ID

integer (int64)

effectiveId
opsiyonel

ID

integer (int64)

fax
opsiyonel

Faks

string

organizationEffectiveId
opsiyonel

Organizasyon ID’si

integer (int64)

phone1
opsiyonel

Telefon 1

string

phone2
opsiyonel

Telefon 2

string

provinceId
opsiyonel

İl ID

integer (int64)

registeredEmail
opsiyonel

KEP E-Posta

string

zipCode
opsiyonel

Posta Kodu

string

6.20. OrganizationDocumentFileInformationDto

İsim Açıklama Şema

fileId
opsiyonel

${FILEID}

integer (int64)

fileName
opsiyonel

Dosya Adı

string

filePath
opsiyonel

Dosya Adı

string

uploadDate
opsiyonel

Yükleme Tarihi

string (date-time)

user
opsiyonel

Kullanıcı

string

6.21. OrganizationDocumentInformationDto

İsim Açıklama Şema

commercialRegistryNewspaperCopy
opsiyonel

Kamu Kayıtlı Ticaret Sicil Gazetesinde Yayımlanan İlan

OrganizationDocumentInformationStatusDto

connectionAgreement
opsiyonel

Bağlantı Sözleşmesi

OrganizationDocumentInformationStatusDto

damParticipationAgreement
opsiyonel

Gün Öncesi Piyasa Katılım Sözleşmesi

OrganizationDocumentInformationStatusDto

effectiveId
opsiyonel

ID

integer (int64)

idmParticipationAgreement
opsiyonel

Gün İçi Piyasa Katılım Sözleşmesi

OrganizationDocumentInformationStatusDto

kf01
opsiyonel

KF01

OrganizationDocumentInformationStatusDto

kf03
opsiyonel

KF03

OrganizationDocumentInformationStatusDto

licenseDocuments
opsiyonel

Lisans Belgeleri

OrganizationDocumentInformationStatusDto

marketParticipationAgreement
opsiyonel

Market Katılım Sözleşmesi

OrganizationDocumentInformationStatusDto

meterSingleLineDiagram
opsiyonel

Tek Hat Çizelge

OrganizationDocumentInformationStatusDto

organizationEffectiveId
opsiyonel

Organizasyon ID’si

integer (int64)

pfmMakerAgreement
opsiyonel

VEP Üretici Sözleşmesi

OrganizationDocumentInformationStatusDto

pfmParticipationAgreement
opsiyonel

VEP Katılım Sözleşmesi

OrganizationDocumentInformationStatusDto

signatureCirculars
opsiyonel

Imza Sirkülerinin İmzalanmış Örnekleri

OrganizationDocumentInformationStatusDto

temporaryAdmission
opsiyonel

Geçici Kabul

OrganizationDocumentInformationStatusDto

6.22. OrganizationDocumentInformationStatusDto

İsim Açıklama Şema

documentType
opsiyonel

Belge Tipi

LookupDTO

files
opsiyonel

< OrganizationDocumentFileInformationDto > array

isChecked
opsiyonel

Onaylandı

boolean

user
opsiyonel

Kullanıcı

string

6.23. OrganizationDto

İsim Açıklama Şema

address
opsiyonel

Adres

string

canParticipateInPfm
opsiyonel

VEP Katılımına Uygun

boolean

code
opsiyonel

Kod

string

districtId
opsiyonel

İlçe ID

integer (int64)

effectiveDateEnd
opsiyonel

Örnek : "2019-12-01T00:00:00+03:00"

string (date-time)

effectiveDateStart
opsiyonel

Örnek : "2019-01-01T00:00:00+03:00"

string (date-time)

effectiveId
opsiyonel

ID

integer (int64)

eic
opsiyonel

ETSO Kodu

string

fax
opsiyonel

Faks

string

hasActiveLicense
opsiyonel

Aktif Durumda Lisans Var

boolean

hasActiveMeter
opsiyonel

Aktif Durumda Ölçüm Noktası Var

boolean

hasActivePowerPlant
opsiyonel

Aktif Durumda Santral Var

boolean

hasActiveSae
opsiyonel

Aktif Durumda UEVÇB Var

boolean

isCategory
opsiyonel

Kategori

boolean

isPfmMaker
opsiyonel

VEP Üretici

boolean

kind
opsiyonel

Tür

LookupDTO

licenseType
opsiyonel

Lisans Tipi

LookupDTO

mainOrganizationId
opsiyonel

Ana Organizasyon ID

integer (int64)

name
opsiyonel

Ad

string

phone1
opsiyonel

Telefon 1

string

phone2
opsiyonel

Telefon 2

string

provinceId
opsiyonel

İl ID

integer (int64)

provinces
opsiyonel

İller

< ProvinceDto > array

readingOrganization
opsiyonel

Sayaç Okuyan Kurum

< ReadingOrganizationDto > array

registeredEmail
opsiyonel

KEP E-Posta

string

shortName
opsiyonel

Kısa Ad

string

state
opsiyonel

Durum

LookupDTO

subType
opsiyonel

Alt Tip

LookupDTO

totalPower
opsiyonel

Toplam Güç

number

type
opsiyonel

Tip

LookupDTO

zipCode
opsiyonel

Posta Kodu

string

6.24. OrganizationFetchDto

İsim Açıklama Şema

effectiveDate
opsiyonel

Geçerlilik Tarihi

string (date-time)

effectiveId
gerekli

ID

integer (int64)

6.25. OrganizationLicenseInformationDto

İsim Açıklama Şema

effectiveId
opsiyonel

ID

integer (int64)

expiryDuration
opsiyonel

Geçerlilik Süresi

integer (int64)

isExpired
opsiyonel

Tarihi Geçmiş

boolean

licenseDateEnd
opsiyonel

Lisans Tarihi Bitiş

string (date-time)

licenseDateStart
opsiyonel

Lisans Tarihi Başlangıç

string (date-time)

licenseNo
opsiyonel

Lisans No

string

licenseType
opsiyonel

Lisans Tipi

LookupDTO

organizationEffectiveId
opsiyonel

Organizasyon ID’si

integer (int64)

organizationName
opsiyonel

Organizasyon Adı

string

organizationState
opsiyonel

Organizasyon Durumu

LookupDTO

6.26. OrganizationListFetchDto

İsim Açıklama Şema

effectiveDate
opsiyonel

Geçerlilik Tarihi

string (date-time)

effectiveIds
opsiyonel

ID’ler

< integer (int64) > array

exclusions
opsiyonel

İstisnalar

< integer (int64) > array

states
opsiyonel

Durumlar

< integer (int64) > array

subTypes
opsiyonel

Alt Tipler

< integer (int64) > array

types
opsiyonel

Tipler

< integer (int64) > array

6.27. OrganizationPfmInformationDto

İsim Açıklama Şema

canParticipateInPfm
opsiyonel

VEP Katılımına Uygun

boolean

effectiveId
opsiyonel

ID

integer (int64)

hasDamOrIdmParticipationDocument
opsiyonel

Gün Öncesi Piyasa Katılım Sözleşmesi sahiplik durumu

boolean

hasOpenInterest
opsiyonel

Açık Pozisyon sahiplik durumu

boolean

hasPendingInvoice
opsiyonel

Bekleyen Fatura sahiplik durumu

boolean

hasPfmMakerAgreementDocument
opsiyonel

VEP Üretici Sözleşmesi sahiplik durumu

boolean

hasPfmParticipationDocument
opsiyonel

Katılım Sözleşmesi sahiplik durumu

boolean

hasSettlementAggregationEntityWithPower
opsiyonel

Sıfırdan fazla güçü bulunan UEVÇB sahiplik durumu

boolean

isParticipatingInPfm
opsiyonel

VEP’e Katılıyor

boolean

isPfmMaker
opsiyonel

VEP Üretici

boolean

organizationEffectiveId
opsiyonel

Organizasyon ID’si

integer (int64)

organizationEic
opsiyonel

Organizasyon ETSO Kodu

string

6.28. OrganizationQueryRequestDto

İsim Açıklama Şema

code
opsiyonel

Kod

string

effectiveDate
opsiyonel

Geçerlilik Tarihi

string (date-time)

effectiveDateEnd
opsiyonel

Geçerlilik Tarihi Bitiş

string (date-time)

effectiveDateStart
opsiyonel

Geçerlilik Tarihi Başlangıç

string (date-time)

effectiveId
opsiyonel

ID

integer (int64)

effectiveIdContains
opsiyonel

ID içerir

string

eic
opsiyonel

ETSO Kodu

string

isCategory
opsiyonel

Kategori

boolean

licenseTypeIds
opsiyonel

Lisans Tipi ID’leri

< integer (int64) > array

mainOrganizationId
opsiyonel

Ana Organizasyon ID

integer (int64)

name
opsiyonel

Ad

string

page
opsiyonel

Page

provinceId
opsiyonel

İl ID

integer (int64)

recordStatusIds
opsiyonel

Kayıt Durumu ID’leri

< integer (int64) > array

shortName
opsiyonel

Kısa Ad

string

stateIds
opsiyonel

Durum ID’leri

< integer (int64) > array

subTypeIds
opsiyonel

Alt Tip ID’leri

< integer (int64) > array

taxNo
opsiyonel

Vergi No

string

typeIds
opsiyonel

Tip ID’leri

< integer (int64) > array

6.29. OrganizationQueryResponseDto

İsim Açıklama Şema

address
opsiyonel

Adres

string

canParticipateInPfm
opsiyonel

VEP Katılımına Uygun

boolean

code
opsiyonel

Kod

string

districtId
opsiyonel

İlçe ID

integer (int64)

effectiveDateEnd
opsiyonel

Geçerlilik Tarihi Bitiş

string (date-time)

effectiveDateStart
opsiyonel

Geçerlilik Tarihi Başlangıç

string (date-time)

effectiveId
opsiyonel

ID

integer (int64)

eic
opsiyonel

ETSO Kodu

string

fax
opsiyonel

Faks

string

isCategory
opsiyonel

Kategori

boolean

isPfmMaker
opsiyonel

VEP Üretici

boolean

licenseType
opsiyonel

Lisans Tipi

LookupDTO

mainOrganizationId
opsiyonel

Ana Organizasyon ID

integer (int64)

name
opsiyonel

Ad

string

phone1
opsiyonel

Telefon 1

string

phone2
opsiyonel

Telefon 2

string

provinceId
opsiyonel

İl ID

integer (int64)

recordStatus
opsiyonel

Kayıt Durumu

LookupDTO

registeredEmail
opsiyonel

KEP E-Posta

string

shortName
opsiyonel

Kısa Ad

string

state
opsiyonel

Durum

LookupDTO

subType
opsiyonel

Alt Tip

LookupDTO

taxNo
opsiyonel

Vergi No

string

totalPower
opsiyonel

Toplam Güç

number

type
opsiyonel

Tip

LookupDTO

zipCode
opsiyonel

Posta Kodu

string

6.30. OrganizationSummaryDto

İsim Açıklama Şema

effectiveId
opsiyonel

ID

integer (int64)

eic
opsiyonel

ETSO Kodu

string

name
opsiyonel

Ad

string

shortName
opsiyonel

Kısa Ad

string

6.31. OrganizationTaxInformationDto

İsim Açıklama Şema

effectiveId
opsiyonel

ID

integer (int64)

organizationEffectiveId
opsiyonel

Organizasyon ID’si

integer (int64)

taxAdministration
opsiyonel

Vergi Dairesi

string

taxNo
opsiyonel

Vergi No

string

6.32. OrganizationWithDamParticipationQueryRequestDto

İsim Açıklama Şema

effectiveDate
gerekli

Geçerlilik Tarihi

string (date-time)

effectiveId
opsiyonel

ID

integer (int64)

eic
opsiyonel

ETSO Kodu

string

isParticipating
opsiyonel

Katılıyor

boolean

stateIds
opsiyonel

Durum ID’leri

< integer (int64) > array

typeIds
opsiyonel

Tip ID’leri

< integer (int64) > array

6.33. OrganizationWithDamParticipationQueryResponseDto

İsim Açıklama Şema

effectiveId
opsiyonel

ID

integer (int64)

eic
opsiyonel

ETSO Kodu

string

isParticipating
opsiyonel

Katılıyor

boolean

name
opsiyonel

Ad

string

shortName
opsiyonel

Kısa Ad

string

stateId
opsiyonel

Durum ID

integer (int64)

typeId
opsiyonel

Tip ID

integer (int64)

6.34. OrganizationsWithLicensesDto

İsim Şema

address
opsiyonel

string

districtId
opsiyonel

integer (int64)

effectiveId
opsiyonel

integer (int64)

eic
opsiyonel

string

fax
opsiyonel

string

isCategory
opsiyonel

boolean

kind
opsiyonel

LookupDTO

licenseType
opsiyonel

LookupDTO

licenses
opsiyonel

< OrganizationLicenseInformationDto > array

mainOrganizationId
opsiyonel

integer (int64)

name
opsiyonel

string

phone1
opsiyonel

string

phone2
opsiyonel

string

provinceId
opsiyonel

integer (int64)

registeredEmail
opsiyonel

string

shortName
opsiyonel

string

state
opsiyonel

LookupDTO

subType
opsiyonel

LookupDTO

type
opsiyonel

LookupDTO

zipCode
opsiyonel

string

6.35. 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.36. PowerPlantQueryRequestDto

İsim Açıklama Şema

effectiveDate
opsiyonel

Geçerlilik Tarihi

string (date-time)

effectiveDateEnd
opsiyonel

Geçerlilik Tarihi Bitiş

string (date-time)

effectiveDateStart
opsiyonel

Geçerlilik Tarihi Başlangıç

string (date-time)

eic
opsiyonel

ETSO Kodu

string

id
opsiyonel

ID

integer (int64)

idContains
opsiyonel

ID içerir

string

ids
opsiyonel

ID’ler

< integer (int64) > array

installedPowerMax
opsiyonel

En Fazla Kurulu Güç

number

installedPowerMin
opsiyonel

En Az Kurulu Güç

number

licenseNumber
opsiyonel

Lisans No

string

licenseTypeIds
opsiyonel

Lisans Tipi ID’leri

< integer (int64) > array

name
opsiyonel

Ad

string

observerDate
opsiyonel

Gözlem Tarihi

string (date-time)

organizationId
opsiyonel

Organizasyon ID

integer (int64)

organizationIdContains
opsiyonel

Organizasyon ID içerir

string

organizationName
opsiyonel

Organizasyon Adı

string

page
opsiyonel

Page

recordStatusIds
opsiyonel

Kayıt Durumu ID’leri

< integer (int64) > array

rsmStatusIds
opsiyonel

Yekdem Durumu ID’leri

< integer (int64) > array

sourceGroupIds
opsiyonel

Kaynak Grubu ID’leri

< integer (int64) > array

sourceTypeIds
opsiyonel

Kaynak Tipi ID’leri

< integer (int64) > array

statusIds
opsiyonel

Durum ID’leri

< integer (int64) > array

trimmingStatusIds
opsiyonel

Kırpma Durumu

< integer (int64) > array

6.37. PowerPlantQueryResponseDto

İsim Açıklama Şema

cycleType
opsiyonel

Çevrim Tipi

LookupDTO

districtId
opsiyonel

İlçe ID

integer (int64)

districtName
opsiyonel

İlçe Adı

string

effectiveDateEnd
opsiyonel

Geçerlilik Tarihi Bitiş

string (date-time)

effectiveDateStart
opsiyonel

Geçerlilik Tarihi Başlangıç

string (date-time)

effectiveId
opsiyonel

ID

integer (int64)

eic
opsiyonel

ETSO Kodu

string

estimatedAnnualProduction
opsiyonel

Hesaplanan Yıllık Üretim

number

firstRecord
opsiyonel

İlk Kayıt

boolean

installedPower
opsiyonel

Kurulu Güç

number

licenseEffectiveId
opsiyonel

Lisans ID

integer (int64)

licenseNo
opsiyonel

Lisans No

string

licenseType
opsiyonel

Lisans Tipi

LookupDTO

maxSupplyPower
opsiyonel

En Fazla Sağlanabilen Güç

number

maxWithdrawalPower
opsiyonel

En Fazla Çekilebilir Güç

number

name
opsiyonel

Ad

string

numberOfUnits
opsiyonel

Adet

integer (int32)

organizationCode
opsiyonel

Organizasyon Kodu

string

organizationEffectiveId
opsiyonel

Organizasyon ID’si

integer (int64)

organizationEic
opsiyonel

Organizasyon ETSO Kodu

string

organizationName
opsiyonel

Organizasyon Adı

string

organizationNameBreakdown
opsiyonel

Organizasyon Adı Kırılımı

< NameBreakdownResponseDto > array

organizationShortName
opsiyonel

Organizasyon Kısa Adı

string

organizationSubType
opsiyonel

Organizasyon Alt Tipi

integer (int64)

power
opsiyonel

Güç

number

powerPlantSupporterSourceType
opsiyonel

Santral Destekleyici Kaynak Tipi

LookupDTO

provinceId
opsiyonel

İl ID

integer (int64)

provinceName
opsiyonel

İl Adı

string

recordStatus
opsiyonel

Kayıt Durumu

LookupDTO

regionalLoadDistributionCenterId
opsiyonel

Bölgesel Yük Dağıtım Merkezi ID

LookupDTO

reservoirArea
opsiyonel

Rezervuar Alanı

number

rsmStatus
opsiyonel

Yekdem Durumu

LookupDTO

sourceGroup
opsiyonel

Kaynak Grubu

LookupDTO

sourceType
opsiyonel

Kaynak Tipi

LookupDTO

status
opsiyonel

Durum

LookupDTO

supporterCapacity
opsiyonel

Destekleyici Kapasite

number

supporterCapacityChangeDate
opsiyonel

Destekleyici Kapasite Değişikliği Tarihi

string (date-time)

supporterInstalledPower
opsiyonel

Destekleyici Kurulu Güç

number

technologyType
opsiyonel

Teknoloji Tipi

PowerPlantTechnologyType

trimmingStatus
opsiyonel

Kırpma Durumu

LookupDTO

trunkVolume
opsiyonel

Hacim

number

unitsDescription
opsiyonel

Adet Açıklaması

string

6.38. PowerPlantRegionQueryRequestDto

İsim Açıklama Şema

effectiveDateEnd
opsiyonel

Geçerlilik Tarihi Bitiş

string (date-time)

effectiveId
gerekli

ID

integer (int64)

6.39. PowerPlantTechnologyType

İsim Şema

clientIp
opsiyonel

string

createDate
opsiyonel

string (date-time)

createUser
opsiyonel

string

host
opsiyonel

string

id
opsiyonel

integer (int64)

isDeleted
opsiyonel

boolean

localizations
opsiyonel

< Localization > array

modifyDate
opsiyonel

string (date-time)

modifyUser
opsiyonel

string

value
opsiyonel

string

6.40. ProvinceDto

İsim Açıklama Şema

id
opsiyonel

ID

string

name
opsiyonel

Ad

string

6.41. ReadingOrganizationDto

İsim Açıklama Şema

id
opsiyonel

ID

integer (int64)

name
opsiyonel

Ad

string

subType
opsiyonel

Alt Tip

LookupDTO

6.42. RegionDto

İsim Açıklama Şema

effectiveDateEnd
opsiyonel

Örnek : "2019-12-01T00:00:00+03:00"

string (date-time)

effectiveDateStart
opsiyonel

Örnek : "2019-01-01T00:00:00+03:00"

string (date-time)

eic
opsiyonel

ETSO Kodu

string

id
opsiyonel

ID

integer (int64)

name
opsiyonel

Ad

string

periodDateEnd
opsiyonel

Periyot Tarihi Bitiş

string (date-time)

periodDateStart
opsiyonel

Periyot Tarihi Başlangıç

string (date-time)

6.43. RestResponse

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyObject

clientIp
opsiyonel

İsteği yapan clientin 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 status 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. RestResponseBody

İsim Şema

content
opsiyonel
sadece okuma

object

6.45. RestResponseBodyLabelValueDTO

İsim Şema

content
opsiyonel
sadece okuma

LabelValueDTO

6.46. RestResponseBodyLabelValueSubTypeDto

İsim Şema

content
opsiyonel
sadece okuma

LabelValueSubTypeDto

6.47. RestResponseBodyLookupResponse

İsim Şema

content
opsiyonel
sadece okuma

LookupResponse

6.48. RestResponseBodyLookupTypeResponse

İsim Şema

content
opsiyonel
sadece okuma

LookupTypeResponse

6.49. RestResponseBodyMarketParticipationDto

İsim Şema

content
opsiyonel
sadece okuma

MarketParticipationDto

6.50. RestResponseBodyObject

İsim Şema

content
opsiyonel
sadece okuma

object

6.51. RestResponseBodyOrganizationCascadeDto

İsim Şema

content
opsiyonel
sadece okuma

OrganizationCascadeDto

6.52. RestResponseBodyOrganizationDto

İsim Şema

content
opsiyonel
sadece okuma

OrganizationDto

6.53. RestResponseBodyOrganizationSummaryDto

İsim Şema

content
opsiyonel
sadece okuma

OrganizationSummaryDto

6.54. RestResponseBodyOrganizationWithDamParticipationQueryResponseDto

İsim Şema

content
opsiyonel
sadece okuma

OrganizationWithDamParticipationQueryResponseDto

6.55. RestResponseBodyOrganizationsWithLicensesDto

İsim Şema

content
opsiyonel
sadece okuma

OrganizationsWithLicensesDto

6.56. RestResponseBodyProvinceDto

İsim Şema

content
opsiyonel
sadece okuma

ProvinceDto

6.57. RestResponseBodyRegionDto

İsim Şema

content
opsiyonel
sadece okuma

RegionDto

6.58. RestResponseBodySaeDto

İsim Şema

content
opsiyonel
sadece okuma

SaeDto

6.59. RestResponseBodySortablePageResponseMarketParticipationDto

İsim Şema

content
opsiyonel
sadece okuma

SortablePageResponseMarketParticipationDto

6.60. RestResponseBodySortablePageResponseOrganizationQueryResponseDto

İsim Şema

content
opsiyonel
sadece okuma

SortablePageResponseOrganizationQueryResponseDto

6.61. RestResponseBodySortablePageResponsePowerPlantQueryResponseDto

İsim Şema

content
opsiyonel
sadece okuma

SortablePageResponsePowerPlantQueryResponseDto

6.62. RestResponseBodySortablePageResponseSaeQueryResponseDto

İsim Şema

content
opsiyonel
sadece okuma

SortablePageResponseSaeQueryResponseDto

6.63. RestResponseError

İsim Açıklama Şema

errorCode
opsiyonel

Alınan hatanın kod bilgisi

string

errorMessage
opsiyonel

Alınan hatanın açıklaması

string

6.64. RestResponseLabelValueDTO

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyLabelValueDTO

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.65. RestResponseLabelValueSubTypeDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyLabelValueSubTypeDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.66. RestResponseLookupResponse

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyLookupResponse

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.67. RestResponseLookupTypeResponse

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyLookupTypeResponse

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.68. RestResponseMarketParticipationDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyMarketParticipationDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.69. RestResponseOrganizationCascadeDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyOrganizationCascadeDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.70. RestResponseOrganizationDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyOrganizationDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.71. RestResponseOrganizationSummaryDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyOrganizationSummaryDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.72. RestResponseOrganizationWithDamParticipationQueryResponseDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyOrganizationWithDamParticipationQueryResponseDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.73. RestResponseOrganizationsWithLicensesDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyOrganizationsWithLicensesDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.74. RestResponseProvinceDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyProvinceDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.75. RestResponseRegionDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodyRegionDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.76. RestResponseSaeDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodySaeDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.77. RestResponseSortablePageResponseMarketParticipationDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodySortablePageResponseMarketParticipationDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.78. RestResponseSortablePageResponseOrganizationQueryResponseDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodySortablePageResponseOrganizationQueryResponseDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.79. RestResponseSortablePageResponsePowerPlantQueryResponseDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodySortablePageResponsePowerPlantQueryResponseDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.80. RestResponseSortablePageResponseSaeQueryResponseDto

İsim Açıklama Şema

body
opsiyonel

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

RestResponseBodySortablePageResponseSaeQueryResponseDto

clientIp
opsiyonel

İsteği yapan clientin 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 status 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.81. SaeDto

İsim Açıklama Şema

balancingMarketParticipationStatus
opsiyonel

Dengeleme Piyasası Katılım Durumu

LookupDTO

effectiveDateEnd
opsiyonel

Geçerlilik Tarihi Bitiş

string (date-time)

effectiveDateStart
opsiyonel

Geçerlilik Tarihi Başlangıç

string (date-time)

eic
opsiyonel

ETSO Kodu

string

greenTariffType
opsiyonel

YETA Abone Grubu

LookupDTO

id
opsiyonel

ID

integer (int64)

name
opsiyonel

Ad

string

oizOrganization
opsiyonel

İlişkili OSB ID

integer (int64)

oizOrganizationName
opsiyonel

İlişkili OSB

string

organizationCode
opsiyonel

Organizasyon Kodu

string

organizationEic
opsiyonel

Organizasyon ETSO Kodu

string

organizationId
opsiyonel

Organizasyon ID

integer (int64)

organizationName
opsiyonel

Organizasyon Adı

string

organizationShortName
opsiyonel

Organizasyon Kısa Adı

string

organizationSubType
opsiyonel

Organizasyon Alt Tipi

integer (int64)

power
opsiyonel

Güç

number

powerPlantId
opsiyonel

Santral ID

integer (int64)

powerPlantName
opsiyonel

Santral Adı

string

regionId
opsiyonel

Bölge ID

integer (int64)

renewableEnergyPriceInTl1
opsiyonel

Yenilenebilir Enerji Fiyatı (TL1)

number

renewableEnergyPriceInTl2
opsiyonel

Yenilenebilir Enerji Fiyatı (TL2)

number

renewableEnergyPriceInUsd
opsiyonel

Yenilenebilir Enerji Fiyatı (USD)

number

status
opsiyonel

Durum

LookupDTO

type
opsiyonel

Tip

LookupDTO

6.82. SaeGetDetailRequestDto

İsim Açıklama Şema

effectiveDate
gerekli

Geçerlilik Tarihi

string (date-time)

id
gerekli

ID

integer (int64)

6.83. SaeQueryRequestDto

İsim Açıklama Şema

balancingMarketParticipationStatusIds
opsiyonel

Dengeleme Piyasası Katılım Durumu ID’leri

< integer (int64) > array

effectiveDate
opsiyonel

Geçerlilik Tarihi

string (date-time)

effectiveDateEnd
opsiyonel

Geçerlilik Tarihi Bitiş

string (date-time)

effectiveDateStart
opsiyonel

Geçerlilik Tarihi Başlangıç

string (date-time)

effectiveId
opsiyonel

ID

integer (int64)

effectiveIdContains
opsiyonel

ID içerir

string

eic
opsiyonel

ETSO Kodu

string

greenTariffTypeIds
opsiyonel

YETA Abone Grubu

< integer (int64) > array

name
opsiyonel

Ad

string

organizationEffectiveId
opsiyonel

Organizasyon ID’si

integer (int64)

organizationEffectiveIdContains
opsiyonel

Organizasyon ID içerir

string

page
opsiyonel

Page

powerPlantEffectiveId
opsiyonel

Santral ID

integer (int64)

powerPlantEffectiveIdContains
opsiyonel

Santral ID içerir

string

powerPlantEffectiveIds
opsiyonel

Santral ID’leri

< integer (int64) > array

recordStatusIds
opsiyonel

Kayıt Durumu ID’leri

< integer (int64) > array

regionId
opsiyonel

Bölge ID

integer (int64)

statusIds
opsiyonel

Durum ID’leri

< integer (int64) > array

typeIds
opsiyonel

Tip ID’leri

< integer (int64) > array

6.84. SaeQueryResponseDto

İsim Açıklama Şema

balancingMarketParticipationStatus
opsiyonel

Dengeleme Piyasası Katılım Durumu

LookupDTO

effectiveDateEnd
opsiyonel

Geçerlilik Tarihi Bitiş

string (date-time)

effectiveDateStart
opsiyonel

Geçerlilik Tarihi Başlangıç

string (date-time)

effectiveId
opsiyonel

ID

integer (int64)

eic
opsiyonel

ETSO Kodu

string

firstRecord
opsiyonel

İlk Kayıt

boolean

greenTariffType
opsiyonel

YETA Abone Grubu

LookupDTO

name
opsiyonel

Ad

string

oizOrganization
opsiyonel

İlişkili OSB ID

integer (int64)

oizOrganizationName
opsiyonel

İlişkili OSB

string

organizationEffectiveId
opsiyonel

Organizasyon ID’si

integer (int64)

organizationName
opsiyonel

Organizasyon Adı

string

power
opsiyonel

Güç

number

powerPlantEffectiveId
opsiyonel

Santral ID

integer (int64)

powerPlantName
opsiyonel

Santral Adı

string

recordStatus
opsiyonel

Kayıt Durumu

LookupDTO

region
opsiyonel

Bölge

RegionDto

status
opsiyonel

Durum

LookupDTO

type
opsiyonel

Tip

LookupDTO

6.85. 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.86. SortablePageResponse

İsim Şema

items
opsiyonel

< object > array

page
opsiyonel

Page

sortableFields
opsiyonel

< string > array

6.87. SortablePageResponseMarketParticipationDto

İsim Şema

items
opsiyonel

< MarketParticipationDto > array

page
opsiyonel

Page

sortableFields
opsiyonel

< string > array

6.88. SortablePageResponseOrganizationQueryResponseDto

İsim Şema

items
opsiyonel

< OrganizationQueryResponseDto > array

page
opsiyonel

Page

sortableFields
opsiyonel

< string > array

6.89. SortablePageResponsePowerPlantQueryResponseDto

İsim Şema

items
opsiyonel

< PowerPlantQueryResponseDto > array

page
opsiyonel

Page

sortableFields
opsiyonel

< string > array

6.90. SortablePageResponseSaeQueryResponseDto

İsim Şema

items
opsiyonel

< SaeQueryResponseDto > array

page
opsiyonel

Page

sortableFields
opsiyonel

< string > array