Genel Bakış

Versiyon bilgisi

Versiyon : 1.0.0

URI şeması

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

Etiketler

  • customer-controller

Doküman Hakkında

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

1. EPYS Abone Servisleri Hakkında

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

3. EPYS Abone 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.

TEST ORTAMI İÇİN

parametre değer

service

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

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

CANLI ORTAMI İÇİN (PROD)

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://epys.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 Talep 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.

TGT ve ST bilgilerini aynı anda gönderme zorunluluğunuz yoktur. İkisinden herhangi birini ya da her ikisini birden gönderebilirsiniz
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 durumunda bu bilgi ile birlikte spanIds göndermeniz zorunludur.

spanIds

string

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

hata almanız durumunda 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. Abone Kayıt

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Piyasa Katılımcısı

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

Yetkiler

ST - Abone İşlemleri - Abone Kaydı Yap
Request 
{
    "agreementChecked": 1,
    "authorizedPerson1Name": "",
    "authorizedPerson1No": "",
    "authorizedPerson2Name": "",
    "authorizedPerson2No": "",
    "byPassUpdatingOfAllCurrentCustomersInPortfolio": null,
    "categoryType": 1,
    "consumptionPointEicCode": "INPUT_EIC",
    "customerNo": "INPUT_TCKN",
    "endDate": null,
    "startDate": "2023-01-23T00:00:00+03:00",
    "title": "INPUT_NAME"
}
Response 
{
    "status": "200 OK",
    "correlationId": "8f880aca-4bba-4e26-a7e8-d58e567525fb",
    "spanIds": "(customer)88506",
    "hostName": "OUTPUT_HOST",
    "clientIp": "OUTPUT_IP",
    "userName": "OUTPUT_USERNAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "eic": "OUTPUT_EIC",
            "consumptionPointId": "OUTPUT_ID",
            "id": "OUTPUT_CUSTOMER_ID",
            "customerStatus": {
                "id": 1,
                "value": null,
                "localizations": null
            },
            "customerNo": "OUTPUT_CUSTOMER_NO",
            "organizationId": "OUTPUT_ORGANIZATION_ID",
            "organizationName": null,
            "organizationNameBreakdown": null,
            "categoryType": {
                "id": 1,
                "value": "REAL_PERSON",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Gerçek Kişi"
                    }
                ]
            },
            "title": "OUTPUT_CUSTOMER_TITLE",
            "startDate": "2023-01-23T00:00:00+03:00",
            "endDate": null,
            "authorizedPerson1Name": "",
            "authorizedPerson2Name": "",
            "authorizedPerson1No": "",
            "authorizedPerson2No": "",
            "createDate": "2023-03-27T22:31:52.952185154+03:00",
            "modifyDate": "2023-03-27T22:31:52.952185154+03:00",
            "modifyUser": "MODIFY_USER",
            "effectiveDateStart": "2023-03-27T22:31:52.899951031+03:00",
            "effectiveDateEnd": "9999-12-31T00:00:00+03:00",
            "updateReason": {
                "id": 1,
                "value": "NEW",
                "localizations": [
                    {
                        "language": "tr-TR",
                        "text": "Yeni Kayıt"
                    }
                ]
            }
        }
    }
}

4.2. Abone Kaydı Güncelle

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Piyasa Katılımcısı

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

Yetkiler

ST - Abone İşlemleri - Abone Kaydı Güncelle
Request 
{
    "authorizedPerson1Name": null,
    "authorizedPerson1No": null,
    "authorizedPerson2Name": null,
    "authorizedPerson2No": null,
    "customerId": "INPUT_CUSTOMER_ID",
    "startDate": "2023-03-23T00:00:00+03:00",
    "endDate": null,
    "title": "INPUT_CUSTOMER_TITLE"
}
Response 
{
    "status": "200 OK",
    "correlationId": "985ebafd-3ba7-49a0-a086-8d6f5472bc1e",
    "spanIds": "(customer)83131",
    "hostName": "OUTPUT_HOST",
    "clientIp": "OUTPUT_IP",
    "userName": "OUTPUT_USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "completed": true
        }
    }
}

4.3. Toplam Sayı Olmadan Abone Listeleme

Servisteki startDate, endDate parametreleri abone kayıt tarihine referans etmektedir. Katılımcılar abone kayıt taihine göre sorgulama yapmak istediklerinde startDate, endDate alanlarını doldurmalıdırlar. Kayıt tarihi olarak da response içinden createDate kullanılabilir.

Servis parametre detaylarına buradan ve buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Piyasa Katılımcısı

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

Yetkiler

ST - Abone İşlemleri - Abone Listele
Request - query-without-count 
{
    "startDate": null,
    "endDate": null,
    "status": [],
    "category": [],
    "customerNo": null,
    "period": "2023-03-01T00:00:00+03:00",
    "consumptionPointEicCode": null,
    "consumptionPointId": "",
    "page": {
        "number": 1,
        "size": 10,
        "sort": {
            "direction": "DESC",
            "field": "startDate"
        }
    }
}
Response query-without-count 
{
    "status": "200 OK",
    "correlationId": "818751cf-7e7d-4f45-bc85-d6f35cbcd5b0",
    "spanIds": "(customer)25522",
    "hostName": "OUTPUT_HOST",
    "clientIp": "OUTPUT_IP",
    "userName": "OUTPUT_USERNAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "items": [
                {
                    "eic": "OUTPUT_EIC",
                    "consumptionPointId": "OUTPUT_ID",
                    "id": 21,
                    "customerStatus": {
                        "id": 1,
                        "value": "ACTIVE",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Aktif"
                            }
                        ]
                    },
                    "customerNo": "OUTPUT_CUSTOMER_NO",
                    "organizationId": "OUTPUT_ORGANIZATION_ID",
                    "organizationName": "OUTPUT_ORGANIZATION_NAME",
                    "organizationNameBreakdown": [
                        {
                            "name": "OUTPUT_ORGANIZATION_NAME",
                            "effectiveDateStart": "2013-04-01T00:00:00+03:00",
                            "effectiveDateEnd": null,
                            "effectiveId": "OUTPUT_ORGANIZATION_ID"
                        }
                    ],
                    "categoryType": {
                        "id": 1,
                        "value": "REAL_PERSON",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Gerçek Kişi"
                            }
                        ]
                    },
                    "title": "OUTPUT_CUSTOMER_TITLE",
                    "startDate": "2023-03-15T00:00:00+03:00",
                    "endDate": null,
                    "authorizedPerson1Name": null,
                    "authorizedPerson2Name": null,
                    "authorizedPerson1No": null,
                    "authorizedPerson2No": null,
                    "createDate": "2023-03-15T11:22:39.347158+03:00",
                    "modifyDate": "2023-03-15T11:22:39.347158+03:00",
                    "modifyUser": "OUTPUT_MODIFY_USER",
                    "effectiveDateStart": "2023-03-15T11:22:39.122544+03:00",
                    "effectiveDateEnd": "9999-12-31T00:00:00+03:00",
                    "updateReason": {
                        "id": 1,
                        "value": "NEW",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Yeni"
                            }
                        ]
                    }
                }
            ],
            "page": {
                "number": 1,
                "size": 10,
                "total": 1,
                "sort": {
                    "field": "startDate",
                    "direction": "DESC"
                }
            },
            "sortableFields": [
                "startDate"
            ]
        }
    }
}
Request - query-count 
{
    "startDate": null,
    "endDate": null,
    "status": [],
    "category": [],
    "customerNo": null,
    "period": "2023-03-01T00:00:00+03:00",
    "consumptionPointEicCode": null,
    "consumptionPointId": ""
}
Response query-count 
{
    "status": "200 OK",
    "correlationId": "818751cf-7e7d-4f45-bc85-d6f35cbcd5b0",
    "spanIds": "(customer)25522",
    "hostName": "OUTPUT_HOST",
    "clientIp": "OUTPUT_IP",
    "userName": "OUTPUT_USERNAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "count": 2870627
        }
    }
}

4.4. Abone Listele

Servisteki startDate, endDate parametreleri abone kayıt tarihine referans etmektedir. Katılımcılar abone kayıt taihine göre sorgulama yapmak istediklerinde startDate, endDate alanlarını doldurmalıdırlar. Kayıt tarihi olarak da response içinden createDate kullanılabilir.

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Piyasa Katılımcısı

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

Yetkiler

ST - Abone İşlemleri - Abone Listele
Request 
{
    "startDate": null,
    "endDate": null,
    "status": [],
    "category": [],
    "customerNo": null,
    "period": "2023-03-01T00:00:00+03:00",
    "consumptionPointEicCode": null,
    "consumptionPointId": "",
    "page": {
        "number": 1,
        "size": 10,
        "sort": {
            "direction": "DESC",
            "field": "startDate"
        }
    }
}
Response 
{
    "status": "200 OK",
    "correlationId": "818751cf-7e7d-4f45-bc85-d6f35cbcd5b0",
    "spanIds": "(customer)25522",
    "hostName": "OUTPUT_HOST",
    "clientIp": "OUTPUT_IP",
    "userName": "OUTPUT_USERNAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "items": [
                {
                    "eic": "OUTPUT_EIC",
                    "consumptionPointId": "OUTPUT_ID",
                    "id": 21,
                    "customerStatus": {
                        "id": 1,
                        "value": "ACTIVE",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Aktif"
                            }
                        ]
                    },
                    "customerNo": "OUTPUT_CUSTOMER_NO",
                    "organizationId": "OUTPUT_ORGANIZATION_ID",
                    "organizationName": "OUTPUT_ORGANIZATION_NAME",
                    "organizationNameBreakdown": [
                        {
                            "name": "OUTPUT_ORGANIZATION_NAME",
                            "effectiveDateStart": "2013-04-01T00:00:00+03:00",
                            "effectiveDateEnd": null,
                            "effectiveId": "OUTPUT_ORGANIZATION_ID"
                        }
                    ],
                    "categoryType": {
                        "id": 1,
                        "value": "REAL_PERSON",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Gerçek Kişi"
                            }
                        ]
                    },
                    "title": "OUTPUT_CUSTOMER_TITLE",
                    "startDate": "2023-03-15T00:00:00+03:00",
                    "endDate": null,
                    "authorizedPerson1Name": null,
                    "authorizedPerson2Name": null,
                    "authorizedPerson1No": null,
                    "authorizedPerson2No": null,
                    "createDate": "2023-03-15T11:22:39.347158+03:00",
                    "modifyDate": "2023-03-15T11:22:39.347158+03:00",
                    "modifyUser": "OUTPUT_MODIFY_USER",
                    "effectiveDateStart": "2023-03-15T11:22:39.122544+03:00",
                    "effectiveDateEnd": "9999-12-31T00:00:00+03:00",
                    "updateReason": {
                        "id": 1,
                        "value": "NEW",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Yeni"
                            }
                        ]
                    }
                }
            ],
            "page": {
                "number": 1,
                "size": 10,
                "total": 1,
                "sort": {
                    "field": "startDate",
                    "direction": "DESC"
                }
            },
            "sortableFields": [
                "startDate"
            ]
        }
    }
}

4.5. Abone Tarihçe Sorgula

Bu servis katılımcılar ve okuyan kurumlar tarafından kullanılmaktadır. Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Tedarik

K1 - Görevli Tedarik Şirketi

K2 - Görevli Tedarik Şirketi

ÜRETİM

OSB - ÜRETİM

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

Yetkiler

ST - Abone İşlemleri - Abone Listele
Request 
{
    "customerId": "INPUT_CUSTOMER_ID",
    "page": {
        "number": 1,
        "size": 10,
        "sort": {
            "direction": "DESC",
            "field": "startDate"
        }
    }
}
Response 
{
    "status": "200 OK",
    "correlationId": "540e7881-efcb-48a9-98d4-d23bcbd832fe",
    "spanIds": "(customer)99481",
    "hostName": "OUTPUT_HOST",
    "clientIp": "OUTPUT_IP",
    "userName": "OUTPUT_USERNAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "items": [
                {
                    "eic": "OUTPUT_EIC",
                    "consumptionPointId": "OUTPUT_ID",
                    "id": 21,
                    "customerStatus": {
                        "id": 1,
                        "value": "ACTIVE",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Aktif"
                            }
                        ]
                    },
                    "customerNo": "OUTPUT_CUSTOMER_NO",
                    "organizationId": "OUTPUT_ORGANIZATION_ID",
                    "organizationName": "OUTPUT_ORGANIZATION_NAME",
                    "organizationNameBreakdown": [
                        {
                            "name": "OUTPUT_ORGANIZATION_NAME",
                            "effectiveDateStart": "2013-04-01T00:00:00+03:00",
                            "effectiveDateEnd": null,
                            "effectiveId": "OUTPUT_ORGANIZATION_ID"
                        }
                    ],
                    "categoryType": {
                        "id": 1,
                        "value": "REAL_PERSON",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Gerçek Kişi"
                            }
                        ]
                    },
                    "title": "OUTPUT_CUSTOMER_TITLE",
                    "startDate": "2023-03-15T00:00:00+03:00",
                    "endDate": null,
                    "authorizedPerson1Name": null,
                    "authorizedPerson2Name": null,
                    "authorizedPerson1No": null,
                    "authorizedPerson2No": null,
                    "createDate": "2023-03-15T11:22:39.347158+03:00",
                    "modifyDate": "2023-03-15T11:22:39.347158+03:00",
                    "modifyUser": "OUTPUT_MODIFY_USER",
                    "effectiveDateStart": "2023-03-15T11:22:39.122544+03:00",
                    "effectiveDateEnd": "9999-12-31T00:00:00+03:00",
                    "updateReason": {
                        "id": 1,
                        "value": "NEW",
                        "localizations": [
                            {
                                "language": "tr-TR",
                                "text": "Yeni"
                            }
                        ]
                    }
                }
            ],
            "page": {
                "number": 1,
                "size": 10,
                "total": 1,
                "sort": {
                    "field": "startDate",
                    "direction": "DESC"
                }
            },
            "sortableFields": [
                "startDate"
            ]
        }
    }
}

4.6. Abone Pasifleştirme

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Tedarik

K1 - Görevli Tedarik Şirketi

K2 - Görevli Tedarik Şirketi

ÜRETİM

OSB - ÜRETİM

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

Yetkiler

ST - Abone İşlemleri - Abone Listele
Request 
{
    "customerId": "INPUT_CUSTOMER_ID",
    "statusId": 0
}
Response 
{
    "status": "200 OK",
    "correlationId": "650dbb68-db7d-4bc7-a7a7-263d8e0a2197",
    "spanIds": "(customer)53028",
    "hostName": "OUTPUT_HOST",
    "clientIp": "OUTPUT_IP",
    "userName": "OUTPUT_USERNAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "completed": true
        }
    }
}

4.7. Kayıt Geçerlilik Ön Kontrolü

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Tedarik

K1 - Görevli Tedarik Şirketi

K2 - Görevli Tedarik Şirketi

ÜRETİM

OSB - ÜRETİM

OSB - DAĞITIM

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

Yetkiler

ST - Abone İşlemleri - Abone Portföy Kontrolü Yap
Request 
{
    "selectedOrganizationId": "INPUT_ORGANIZATION_ID",
    "consumptionPointEicCode": "INPUT_EIC",
    "consumptionPointId": "INPUT_ID",
    "startDate": "2023-03-23T00:00:00+03:00",
    "endDate": null,
    "myPortfolioState": 0
}
Response 
{
    "status": "200 OK",
    "correlationId": "744fd8c4-a9bc-4365-9d95-080bae25c828",
    "spanIds": "(customer)54175",
    "hostName": "OUTPUT_HOST",
    "clientIp": "OUTPUT_IP",
    "userName": "OUTPUT_USERNAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "consumptionPointEicCode": "INPUT_EIC",
            "startDate": "2023-03-22T21:00:00Z",
            "endDate": null,
            "selectedOrganizationName": "INPUT_ORGANIZATION_NAME",
            "selectedOrganizationId": "INPUT_ORGANIZATION_ID",
            "eligibleForOperation": true
        }
    }
}

4.8. Portföyde Önceden Tanımlanmış Abone Durumunu Getir

Servis parametre detaylarına buradan erişebilirsiniz.

Katılımcılar:

Sayaç Okuyan Kurum

Piyasa Katılımcısı

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

Yetkiler

ST - Abone İşlemleri - Abone Kaydı Yap
Request 
{
    "categoryType": 1,
    "customerNo": "INPUT_TCKN"
}
Response 
{
    "status": "200 OK",
    "correlationId": "3079bcfc-c2ac-4029-8230-c23ce485b7dd",
    "spanIds": "(customer)64850",
    "hostName": "OUTPUT_HOST",
    "clientIp": "OUTPUT_IP",
    "userName": "OUTPUT_USERNAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "completed": false
        }
    }
}

4.9. 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

Abone İşlemleri - Mevcut Çoklu Seçim Anahtar Sorgulama Servisi Admin Yetkisi
Response 
{
    "status": "200 OK",
    "correlationId": "6108fbdd-7eb4-440e-b523-473005ab9c95",
    "spanIds": "(customer)50964",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": "USER_NAME",
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "types": [
                {
                    "lookupType": "categoryType",
                    "lookupDescription": ""
                },
                {
                    "lookupType": "bilateralAgreementState",
                    "lookupDescription": ""
                },
                {
                    "lookupType": "updateReason",
                    "lookupDescription": ""
                },
                {
                    "lookupType": "customerStatus",
                    "lookupDescription": ""
                },
                {
                    "lookupType": "myPortfolioState",
                    "lookupDescription": ""
                },
                {
                    "lookupType": "processType",
                    "lookupDescription": ""
                }
            ]
        }
    }
}

4.10. Ç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

Abone İşlemleri - Çoklu Seçim Detay Sorgulama Servisi Admin Yetkisi
Request 
{
    "lookupType":"INPUT_MULTIPLE_CHOICE_KEY"
}
Response 
{
    "status": "200 OK",
    "correlationId": "1f1f0072-4a1e-4da5-8158-23a34af944ba",
    "spanIds": "(customer)71027",
    "hostName": "*.*.*.*",
    "clientIp": "*.*.*.*",
    "userName": null,
    "successMessage": null,
    "errors": null,
    "body": {
        "content": {
            "values": null
        }
    }
}

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. Portföyde önceden Tanımlanmış Abone Durumunu Getir

POST v1/customer/get-state-customer-predefined-in-portfolio

5.3.1. Açıklama

Tüketicinin bu kayıttan etkilenerek güncellenecek başka aboneliğinin olup olmadığının kontrol edildiği servistir.

5.3.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

StatePredefinedCustomerInPortfolioRequestDto

5.3.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseBooleanDTO

5.3.4. Kullanılanlar

  • application/json

  • application/xml

5.3.5. Üretilenler

  • application/json

  • application/xml

5.3.6. Etiketler

  • customer-controller

5.4. Abone Tarihçe Sorgula

POST v1/customer/history

5.4.1. Açıklama

Abone üzerinde yapılan değişikliklerin sorgulandığı servistir.

5.4.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

CustomerHistoryRequestDto

5.4.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSortablePageResponseCustomerDto

5.4.4. Kullanılanlar

  • application/json

  • application/xml

5.4.5. Üretilenler

  • application/json

  • application/xml

5.4.6. Etiketler

  • customer-controller

5.5. Abone Pasife Al

POST v1/customer/passivate-customer

5.5.1. Açıklama

Aktif aboneleri pasife alabileceğiniz servistir.

5.5.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

CustomerPassivateRequestDto

5.5.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseBooleanDTO

5.5.4. Kullanılanlar

  • application/json

  • application/xml

5.5.5. Üretilenler

  • application/json

  • application/xml

5.5.6. Etiketler

  • customer-controller

5.6. Kayıt Geçerlilik Ön Kontrolü

POST v1/customer/pre-check

5.6.1. Açıklama

Önyüz kullanımı için abonenin kaydını yapılıp yapılamacağının bilgisinin aldığı servistir. Kayıt servisi ön kontrol olarak bu validasyonaları yapmaktadır.

5.6.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

CustomerPreCheckRequestDto

5.6.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseCustomerPreCheckResponse

5.6.4. Kullanılanlar

  • application/json

  • application/xml

5.6.5. Üretilenler

  • application/json

  • application/xml

5.6.6. Etiketler

  • customer-controller

5.7. Abone Sorgula

POST v1/customer/query

5.7.1. Açıklama

Portföyünüzde yer alan veya sorumlusu olduğunuz abonelerin sorgulandığı servistir.

5.7.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

CustomerQueryRequestDto

5.7.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSortablePageResponseCustomerDto

5.7.4. Kullanılanlar

  • application/json

  • application/xml

5.7.5. Üretilenler

  • application/json

  • application/xml

5.7.6. Etiketler

  • customer-controller

5.8. Abone Sorgulama Kayıt Sayısı

POST v1/customer/query-count

5.8.1. Açıklama

Portföyünüzde yer alan veya sorumlusu olduğunuz abonelerin kayıt sayılarının sorgulandığı servistir.

5.8.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

CustomerQueryCountRequestDto

5.8.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseCustomerQueryCountResponseDto

5.8.4. Kullanılanlar

  • application/json

  • application/xml

5.8.5. Üretilenler

  • application/json

  • application/xml

5.8.6. Etiketler

  • customer-controller

5.9. Kayıt Sayısı Olmadan Abone Sorgulama

POST v1/customer/query-without-count

5.9.1. Açıklama

Portföyünüzde yer alan veya sorumlusu olduğunuz abonelerin kayıt sayısı olmadan sorgulandığı servistir.

5.9.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

CustomerQueryRequestDto

5.9.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseSortablePageResponseCustomerDto

5.9.4. Kullanılanlar

  • application/json

  • application/xml

5.9.5. Üretilenler

  • application/json

  • application/xml

5.9.6. Etiketler

  • customer-controller

5.10. Abone Kaydet

POST v1/customer/register

5.10.1. Açıklama

Portföyünüzde yer alan abonenin kaydını yapan servistir.

5.10.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

CustomerRegisterRequestDto

5.10.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseCustomerDto

5.10.4. Kullanılanlar

  • application/json

  • application/xml

5.10.5. Üretilenler

  • application/json

  • application/xml

5.10.6. Etiketler

  • customer-controller

5.11. Abone Güncelle

POST v1/customer/update

5.11.1. Açıklama

Abone bilgilerinin güncellendiği servistir.

5.11.2. Parametreler

Tip İsim Şema

Body

body
opsiyonel

CustomerUpdateRequestDto

5.11.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

RestResponseBooleanDTO

5.11.4. Kullanılanlar

  • application/json

  • application/xml

5.11.5. Üretilenler

  • application/json

  • application/xml

5.11.6. Etiketler

  • customer-controller

6. Tanımlar

6.1. BaseDTO

Tip : object

6.2. BooleanDTO

İsim Şema

completed
opsiyonel

boolean

6.3. CustomerDto

İsim Açıklama Şema

authorizedPerson1Name
opsiyonel

Birinci yetkili kişi ad/soyad bilgisi.

string

authorizedPerson1No
opsiyonel

Birinci yetkili kişi tckn bilgisi.

string

authorizedPerson2Name
opsiyonel

İkinci yetkili kişi ad/soyad bilgisi.

string

authorizedPerson2No
opsiyonel

İkinci yetkili kişi tckn bilgisi.

string

categoryType
opsiyonel

Abone kategori tipi lookup değeridir.

LookupDTO

consumptionPointId
opsiyonel

Sayaca ait tüketim noktası id.

integer (int64)

createDate
opsiyonel

Kayıt yaratılma tarihi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

customerNo
opsiyonel

Abone tüketici no bilgisi.

string

customerStatus
opsiyonel

Abone durumu lookup değeridir.

LookupDTO

effectiveDateEnd
opsiyonel

Kayıt geçerlilik bitiş tarihi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

effectiveDateStart
opsiyonel

Kayıt geçerlilik başlangıç tarihi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

eic
opsiyonel

Sayaca ait enerji tanımlama kodu (EIC).

string

endDate
opsiyonel

Abone portföy bitiş bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

id
opsiyonel

Abone kayıt id.

integer (int64)

modifyDate
opsiyonel

Kayıt güncellenme tarihi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

modifyUser
opsiyonel

Kayıt güncelleyen kullanıcı.

string

organizationId
opsiyonel

Abonenin kayıtlı olduğu organizasyonun id bilgisi.

integer (int64)

organizationName
opsiyonel

Abonenin kayıtlı olduğu organizasyonun ad bilgisi.

string

organizationNameBreakdown
opsiyonel

Abonenin kayıtlı olduğu organizasyonun tarihçesi.

< NameBreakdownResponseDto > array

startDate
opsiyonel

Abone portföy başlangıç bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

title
opsiyonel

Tüketici ad/soyad veya ünvan bilgisi.

string

updateReason
opsiyonel

Abone güncellenme nedeni lookup değeridir.

LookupDTO

6.4. CustomerHistoryRequestDto

İsim Açıklama Şema

customerId
gerekli

Abone kayıt id.

integer (int64)

page
opsiyonel

Page

6.5. CustomerPassivateRequestDto

İsim Açıklama Şema

customerId
gerekli

Abone kayıt id.

integer (int64)

statusId
gerekli

Abone durumu lookup değeridir.

integer (int64)

6.6. CustomerPreCheckRequestDto

İsim Açıklama Şema

consumptionPointEicCode
opsiyonel

Sayaca ait enerji tanımlama kodu (EIC).

string

consumptionPointId
opsiyonel

Sayaca ait tüketim noktası id.

integer (int64)

endDate
opsiyonel

Abone portföy bitiş bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

myPortfolioState
opsiyonel

Portföyünde bulunma durumu lookup değeri.

integer (int64)

startDate
gerekli

Abone portföy başlangıç bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

6.7. CustomerPreCheckResponse

İsim Açıklama Şema

consumptionPointEicCode
opsiyonel

Sayaca ait enerji tanımlama kodu (EIC).

string

endDate
opsiyonel

Abone portföy bitiş bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

isEligibleForOperation
opsiyonel

Yapılan isteğin geçerli olup olmama durumu.

boolean

selectedOrganizationId
opsiyonel

Organizasyon Id.

integer (int64)

selectedOrganizationName
opsiyonel

Organizasyon Adı.

string

startDate
opsiyonel

Abone portföy başlangıç bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

6.8. CustomerQueryCountRequestDto

İsim Açıklama Şema

category
opsiyonel

Abone kategori tipi lookup değeridir.

< integer (int64) > array

consumptionPointEicCode
opsiyonel

Sayaca ait enerji tanımlama kodu (EIC). Tüketim noktası id gönderildiği durumda gönderilmemelidir.
Örnek : "40X000000000002C"

string

consumptionPointId
opsiyonel

Sayaca ait tüketim noktası id. EIC gönderildiği durumda gönderilmemelidir.

integer (int64)

customerNo
opsiyonel

Abone tüketici no bilgisi.

string

endDate
opsiyonel

Abone portföy bitiş bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

id
opsiyonel

Abone kayıt id.

integer (int64)

period
opsiyonel

Dönem bilgisi
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

startDate
opsiyonel

Abone portföy başlangıç bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

status
opsiyonel

Abone durumu lookup değeridir.

< integer (int64) > array

6.9. CustomerQueryCountResponseDto

İsim Açıklama Şema

count
opsiyonel

Kayıt Sayısı

integer (int64)

6.10. CustomerQueryRequestDto

İsim Açıklama Şema

category
opsiyonel

Abone kategori tipi lookup değeridir.

< integer (int64) > array

consumptionPointEicCode
opsiyonel

Sayaca ait enerji tanımlama kodu (EIC). Tüketim noktası id gönderildiği durumda gönderilmemelidir.
Örnek : "40X000000000002C"

string

consumptionPointId
opsiyonel

Sayaca ait tüketim noktası id. EIC gönderildiği durumda gönderilmemelidir.

integer (int64)

customerNo
opsiyonel

Abone tüketici no bilgisi.

string

endDate
opsiyonel

Abone portföy bitiş bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

id
opsiyonel

Abone kayıt id.

integer (int64)

page
opsiyonel

Sorgulama Sayfası

Page

period
opsiyonel

Dönem bilgisi
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

startDate
opsiyonel

Abone portföy başlangıç bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

status
opsiyonel

Abone durumu lookup değeridir.

< integer (int64) > array

6.11. CustomerRegisterRequestDto

İsim Açıklama Şema

authorizedPerson1Name
opsiyonel

Birinci yetkili kişi ad/soyad bilgisi. Abone tipine göre zorunluluk arz edebilir.

string

authorizedPerson1No
opsiyonel

Birinci yetkili kişi tckn bilgisi. Abone tipine göre zorunluluk arz edebilir.

string

authorizedPerson2Name
opsiyonel

İkinci yetkili kişi ad/soyad bilgisi.

string

authorizedPerson2No
opsiyonel

İkinci yetkili kişi tckn bilgisi.

string

categoryType
gerekli

Abone kategori tipi lookup değeridir.

integer (int64)

consumptionPointEicCode
opsiyonel

Sayaca ait enerji tanımlama kodu (EIC). Tüketim noktası id gönderildiği durumda gönderilmemelidir.
Örnek : "40X000000000002C"

string

consumptionPointId
opsiyonel

Sayaca ait tüketim noktası id. EIC gönderildiği durumda gönderilmemelidir.

integer (int64)

customerNo
gerekli

Abone tüketici no bilgisi.

string

endDate
opsiyonel

Abone portföy bitiş bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

isAgreementChecked
gerekli

Abone ile yapılmış ikili anlaşma durumu.

boolean

startDate
gerekli

Abone portföy başlangıç bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

title
gerekli

Tüketici ad/soyad veya ünvan bilgisi.

string

6.12. CustomerUpdateRequestDto

İsim Açıklama Şema

authorizedPerson1Name
opsiyonel

Birinci yetkili kişi ad/soyad bilgisi. Abone tipine göre zorunluluk arz edebilir.

string

authorizedPerson1No
opsiyonel

Birinci yetkili kişi tckn bilgisi. Abone tipine göre zorunluluk arz edebilir.

string

authorizedPerson2Name
opsiyonel

İkinci yetkili kişi ad/soyad bilgisi.

string

authorizedPerson2No
opsiyonel

İkinci yetkili kişi tckn bilgisi.

string

customerId
gerekli

Abone kayıt id.

integer (int64)

endDate
opsiyonel

Abone portföy bitiş bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

startDate
opsiyonel

Abone portföy başlangıç bilgisi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

title
opsiyonel

Tüketici ad/soyad veya ünvan bilgisi.

string

6.13. LocalizationDTO

İsim Açıklama Şema

language
opsiyonel

Çoklu Seçim Dili

string

text
opsiyonel

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

string

6.14. 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.15. LookupRequest

İsim Açıklama Şema

lookupType
gerekli

Çoklu Seçim Anahtarı

string

6.16. LookupResponse

İsim Açıklama Şema

values
opsiyonel

Çoklu Seçim Değer Listesi

< LookupDTO > array

6.17. LookupTypeDTO

İsim Açıklama Şema

lookupDescription
opsiyonel

Çoklu Seçim Anahtar Açıklama

string

lookupType
opsiyonel

Çoklu Seçim Anahtarı

string

6.18. LookupTypeResponse

İsim Açıklama Şema

types
opsiyonel

Çoklu Seçim Anahtar Listesi

< LookupTypeDTO > array

6.19. NameBreakdownResponseDto

İsim Açıklama Şema

effectiveDateEnd
opsiyonel

Kayıt geçerlilik bitiş tarihi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

effectiveDateStart
opsiyonel

Kayıt geçerlilik başlangıç tarihi.
Örnek : "2020-01-01T00:00:00+03:00"

string (date-time)

effectiveId
opsiyonel

Organizasyon Id.

integer (int64)

name
opsiyonel

Organizasyon Adı.

string

6.20. 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.21. 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.22. RestResponseBody

İsim Şema

content
opsiyonel
sadece okuma

object

6.23. RestResponseBodyBooleanDTO

İsim Şema

content
opsiyonel
sadece okuma

BooleanDTO

6.24. RestResponseBodyCustomerDto

İsim Şema

content
opsiyonel
sadece okuma

CustomerDto

6.25. RestResponseBodyCustomerPreCheckResponse

İsim Şema

content
opsiyonel
sadece okuma

CustomerPreCheckResponse

6.26. RestResponseBodyCustomerQueryCountResponseDto

İsim Şema

content
opsiyonel
sadece okuma

CustomerQueryCountResponseDto

6.27. RestResponseBodyLookupResponse

İsim Şema

content
opsiyonel
sadece okuma

LookupResponse

6.28. RestResponseBodyLookupTypeResponse

İsim Şema

content
opsiyonel
sadece okuma

LookupTypeResponse

6.29. RestResponseBodyObject

İsim Şema

content
opsiyonel
sadece okuma

object

6.30. RestResponseBodySortablePageResponseCustomerDto

İsim Şema

content
opsiyonel
sadece okuma

SortablePageResponseCustomerDto

6.31. RestResponseBooleanDTO

İ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.

RestResponseBodyBooleanDTO

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.32. RestResponseCustomerDto

İ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.

RestResponseBodyCustomerDto

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.33. RestResponseCustomerPreCheckResponse

İ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.

RestResponseBodyCustomerPreCheckResponse

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.34. RestResponseCustomerQueryCountResponseDto

İ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.

RestResponseBodyCustomerQueryCountResponseDto

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.35. RestResponseError

İsim Açıklama Şema

errorCode
opsiyonel

Alınan hatanın kod bilgisi.

string

errorMessage
opsiyonel

Alınan hatanın açıklaması.

string

6.36. 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.37. 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.38. RestResponseSortablePageResponseCustomerDto

İ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.

RestResponseBodySortablePageResponseCustomerDto

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.39. 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.40. SortablePageResponse

İsim Şema

items
opsiyonel

< object > array

page
opsiyonel

Page

sortableFields
opsiyonel

< string > array

6.41. SortablePageResponseCustomerDto

İsim Şema

items
opsiyonel

< CustomerDto > array

page
opsiyonel

Page

sortableFields
opsiyonel

< string > array

6.42. StatePredefinedCustomerInPortfolioRequestDto

İsim Açıklama Şema

categoryType
gerekli

Abone kategori tipi lookup değeridir.

integer (int64)

customerNo
gerekli

Abone tüketici no bilgisi.

string