Genel Bakış

Versiyon bilgisi

Versiyon : v1

URI şeması

Sunucu : stp.epias.com.tr
Kök Dizin : /stp-helper-orchestrator/rest
Şemalar : HTTPS

Etiketler

  • announcement

  • helper

  • operationcode

  • operationcodegroup

  • operationhistory

  • parameter

  • public-holiday

Döküman Hakkında

Bu dökümanda Yardımcı Servislerin tanımları ve bu servislerin nasıl çağrılacağı anlatılmaktadır.

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

Değişiklikler

1.0.0 Servis tanımları

Uygulama Hakkında

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

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

İstemci Oluşturmak

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

Yardım ve Destek

Uygulama konusundaki istek ve görüşlerinizi Yardım Platformu ( https://yardim.epias.com.tr ) aracılığıyla iletebilirsiniz.

Uygulama Servis Çağrımı

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

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

Ticket Granting Ticket (TGT) Oluşturma

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

parametre değer

xml

xml response döner

json

json response döner

text

text response döner

Gönderilen HTTP isteğinin header kısmında Content-Type ise aşağıdaki değerleri alabilir.

parametre değer

xml

application/xml

json

application/json

text

application/x-www-form-urlencoded
parametre değer

username

Kullanıcı Adı

password

Şifre
ö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=KULLANICI_ADIM&password=ŞİFREM

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

Service Ticket (ST) Oluşturma

ST oluşturmak için önce TGT alınmalıdır. TGT alındıktan sonra şu şekilde bir istek adresi oluşturulur. Gerçek ortam için https://cas.epias.com.tr/cas/v1/tickets/{TGT} test ortamı için https://cas.epias.com.tr/cas/v1/tickets/{TGT} ST için xml veya JSON cevap alabilmeniz için url şu şekilde oluşturmalısınız.

örnek xml tipinde cevap için url formatı
https://cas.epias.com.tr/cas/v1/tickets/TGT-229-2hmcHafszagAAxtCh017nax1en3U9TouWeGvIrq9KbSbeKE9Zk-cas02.epias.com.tr?format=xml
cevap
<st>ST12312312312321</st>
örnek json tipinde cevap için url formatı
https://cas.epias.com.tr/cas/v1/tickets/TGT-229-2hmcHafszagAAxtCh017nax1en3U9TouWeGvIrq9KbSbeKE9Zk-cas02.epias.com.tr?format=json
cevap
{"st":"ST12312312312321"}
parametre değer

xml

xml response döner

json

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

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

parametre değer

service

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

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

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

Uygulama Örnek Mesaj Yapısı

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

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

parametre değer

stp-service-ticket

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

Accept

application/json veya application/xml

Content-Type

application/json veya application/xml

Accept-Language

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

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

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

parametre değer açıklama

transactionId

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

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

application

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

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

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

header alanını anahtar (key) ve değer (value) şeklinde gönderilmelidir.
Servise gelen ve giden tüm mesajlardaki tarih alanları ISO-8601 formatındadır. Format yyyy-MM-dd’T’HH:mm:ss.SSSXXX şeklinde olmalıdır. Timezone değeri Yaz Saati Uygulamasında için +03:00 Kış Saatin Uygulamasında +02:00 olarak değişmektedir. O yüzden dökümanın içerisinde verilen örnek JSON dosyalarındaki tarih alanlarına dikkat ediniz. Örnek bir zaman değeri şu şekildedir. 2016-03-25T00:00:00.000+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:ss.SSSXXX");
        try
        {
            return sdf.parse(v);
        } catch (ParseException e)
        {
            throw new RuntimeException(e);
        }
    }

    public static String toISO8601Date(Date v)
    {
        if (null == v) return null;
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSSXXX");
        return sdf.format(v);
    }
}
Örnek HTTP Mesajı
POST /stp-organization-service/rest/organization/save HTTP/1.1
Host: testtysapi.epias.com.tr
Accept: application/json
Content-Type: application/json
stp-service-ticket: ST-31352-VjHOo5iDV4fDkOod3jZc-cas02.epias.com.tr
Cache-Control: no-cache

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

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

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

parametre tip değer açıklama

resultCode

string

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

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

resultDescription

string

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

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

resultType

string

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

Postman Kullanımı

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

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

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

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

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

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

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

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

Servis Detayları

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

1. Yardımcı Veri Servisi

1.1. Yardımcı Veri servisi nasıl çağrılır?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İsteği
<?xml version="1.0" encoding="UTF-8" ?>
<helperDataGetRequest>
    <headers>
        <key>transactionId</key>
        <value>57a064d5-2eb3-4a0b-bc71-7679d68e5961</value>
    </headers>
    <headers>
        <key>application</key>
        <value>demoIstemci</value>
    </headers>
    <body>
        <parameter>city</parameter>
        <marketType>NATURAL_GAS</marketType>
    </body>
</helperDataGetRequest>
Örnek XML Cevabı
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<helperDataGetServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <referenceListResponse>
            <key>1</key>
            <description>Tek Devre</description>
        </referenceListResponse>
        <referenceListResponse>
            <key>2</key>
            <description>Çift Devre</description>
        </referenceListResponse>
        <referenceListResponse>
            <key>3</key>
            <description>Üç Devre</description>
        </referenceListResponse>
    </body>
</helperDataGetServiceResponse>
Örnek Json İsteği
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
    "parameter": "city",
    "marketType": "NATURAL_GAS"
  }
}
Örnek Json Cevabı
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "referenceListResponse": [
      {
        "key": "1",
        "description": "Tek Devre",
        "addition": null
      },
      {
        "key": "2",
        "description": "Çift Devre",
        "addition": null
      },
      {
        "key": "3",
        "description": "Üç Devre",
        "addition": null
      }
    ]
  }
}

2. Parametre Servisi

2.1. Parametre servisi nasıl çağrılır?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İsteği
<?xml version="1.0" encoding="UTF-8" ?>
<parameterGetRequest>
    <headers>
        <key>transactionId</key>
        <value>57a064d5-2eb3-4a0b-bc71-7679d68e5961</value>
    </headers>
    <headers>
        <key>application</key>
        <value>demoIstemci</value>
    </headers>
    <body>
        <parameterGroupKey>PARAMETER_GROUP_1</parameterGroupKey>
        <parameterKey>PARAMETER_KEY_1</parameterKey>
        <effectiveDate>2017-06-01T00:00:00.000+03:00</effectiveDate>
        <marketType>NATURAL_GAS</marketType>
    </body>
</parameterGetRequest>
Örnek XML Cevabı
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<parameterGetServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <parameterGetResponses>
            <key>PARAMETER_KEY_1</key>
            <value>a</value>
        </parameterGetResponses>
    </body>
</parameterGetServiceResponse>
Örnek Json İsteği
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
    "parameterGroupKey": "PARAMETER_GROUP_1",
    "parameterKey": "PARAMETER_KEY_1",
    "effectiveDate": "2017-06-01T00:00:00.000+03:00",
    "marketType": "NATURAL_GAS"
  }
}
Örnek Json Cevabı
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "parameterGetResponses": [
      {
        "key": "PARAMETER_KEY_1",
        "value": "a"
      }
    ]
  }
}

2.2. Parametre Detay servisi nasıl çağrılır?

Servis parametre detaylarına buradan erişebilirsiniz.

Sample XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<parameterGetRequest>
    <headers>
        <key>transactionId</key>
        <value>57a064d5-2eb3-4a0b-bc71-7679d68e5961</value>
    </headers>
    <headers>
        <key>application</key>
        <value>demoIstemci</value>
    </headers>
    <body>
        <parameterGroupKey>ORGANIZATION_ORCHESTRATOR</parameterGroupKey>
        <parameterKey>LAST_NOTIFICATION_DELAY</parameterKey>
        <effectiveDate>2017-06-01T00:00:00.000+03:00</effectiveDate>
        <marketType>NATURAL_GAS</marketType>
    </body>
</parameterGetRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<parameterDetailServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <parameterDetailResponses>
            <key>LAST_NOTIFICATION_DELAY</key>
            <groupKey>ORGANIZATION_ORCHESTRATOR</groupKey>
            <value>10</value>
            <modifyUser>CAKYOL</modifyUser>
            <effectiveStartDate>2017-01-01T00:00:00.000+03:00</effectiveStartDate>
            <effectiveEndDate>2017-07-28T19:57:40.488+03:00</effectiveEndDate>
            <description>Last Notification Time (day)</description>
        </parameterDetailResponses>
    </body>
</parameterDetailServiceResponse>
Sample Json Request
{
        "headers": [
                {
                        "key": "application",
                        "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
                },
                {
                        "key": "transactionId",
                        "value": "d883f25c-413d-41e8-b695-9731186950dd"
                }
        ],
  "body": {
    "parameterGroupKey": "ORGANIZATION_ORCHESTRATOR",
    "parameterKey": "LAST_NOTIFICATION_DELAY",
    "marketType": "NATURAL_GAS",
    "effectiveDate": "2017-07-15T16:57:40.488Z"

  }
}
Sample Json Response
{
    "resultCode": "0",
    "resultDescription": "OK",
    "resultType": "SUCCESS",
    "body": {
        "parameterDetailResponses": [
            {
                "key": "LAST_NOTIFICATION_DELAY",
                "groupKey": "ORGANIZATION_ORCHESTRATOR",
                "value": "10",
                "modifyUser": "SYSTEM",
                "effectiveStartDate": "2017-01-01T00:00:00.000+03:00",
                "effectiveEndDate": "2099-12-31T00:00:00.000+03:00",
                "description": "Last Notification Time (day)"
            }
        ]
    }
}

2.3. Parametre Geçmişi servisi nasıl çağrılır?

Servis parametre detaylarına buradan erişebilirsiniz.

Sample XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<parameterHistoryServiceRequest>
    <headers>
        <key>transactionId</key>
        <value>57a064d5-2eb3-4a0b-bc71-7679d68e5961</value>
    </headers>
    <headers>
        <key>application</key>
        <value>demoIstemci</value>
    </headers>
    <body>
        <parameterGroupKey>ORGANIZATION_ORCHESTRATOR</parameterGroupKey>
        <parameterKey>LAST_NOTIFICATION_DELAY</parameterKey>
        <marketType>NATURAL_GAS</marketType>
    </body>
</parameterHistoryServiceRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<parameterHistoryServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <parameterDetailResponses>
            <key>LAST_NOTIFICATION_DELAY</key>
            <groupKey>ORGANIZATION_ORCHESTRATOR</groupKey>
            <value>15</value>
            <modifyUser>CAKYOL</modifyUser>
            <effectiveStartDate>2017-07-28T19:57:40.488+03:00</effectiveStartDate>
            <effectiveEndDate>9999-12-31T00:00:00.000+03:00</effectiveEndDate>
            <description>Last Notification Time (day)</description>
        </parameterDetailResponses>
        <parameterDetailResponses>
            <key>LAST_NOTIFICATION_DELAY</key>
            <groupKey>ORGANIZATION_ORCHESTRATOR</groupKey>
            <value>10</value>
            <modifyUser>CAKYOL</modifyUser>
            <effectiveStartDate>2017-01-01T00:00:00.000+03:00</effectiveStartDate>
            <effectiveEndDate>2017-07-28T19:57:40.488+03:00</effectiveEndDate>
            <description>Last Notification Time (day)</description>
        </parameterDetailResponses>
    </body>
</parameterHistoryServiceResponse>
Sample Json Request
{
        "headers": [
                {
                        "key": "application",
                        "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
                },
                {
                        "key": "transactionId",
                        "value": "d883f25c-413d-41e8-b695-9731186950dd"
                }
        ],
  "body": {
    "parameterGroupKey": "ORGANIZATION_ORCHESTRATOR",
    "parameterKey": "LAST_NOTIFICATION_DELAY",
    "marketType": "NATURAL_GAS"
  }
}
Sample Json Response
{
    "resultCode": "0",
    "resultDescription": "OK",
    "resultType": "SUCCESS",
    "body": {
        "parameterDetailResponses": [
            {
                "key": "LAST_NOTIFICATION_DELAY",
                "groupKey": "ORGANIZATION_ORCHESTRATOR",
                "value": "15",
                "modifyUser": "CAKYOL",
                "effectiveStartDate": "2017-07-28T19:57:40.488+03:00",
                "effectiveEndDate": "9999-12-31T00:00:00.000+03:00",
                "description": "Last Notification Time (day)"
            },
            {
                "key": "LAST_NOTIFICATION_DELAY",
                "groupKey": "ORGANIZATION_ORCHESTRATOR",
                "value": "10",
                "modifyUser": "CAKYOL",
                "effectiveStartDate": "2017-01-01T00:00:00.000+03:00",
                "effectiveEndDate": "2017-07-28T19:57:40.488+03:00",
                "description": "Last Notification Time (day)"
            }
        ]
    }
}

2.4. Parametre Kaydetme servisi nasıl çağrılır?

Servis parametre detaylarına buradan erişebilirsiniz.

Sample XML Request
<?xml version="1.0" encoding="UTF-8" ?>
<parameterSaveServiceRequest>
    <headers>
        <key>transactionId</key>
        <value>57a064d5-2eb3-4a0b-bc71-7679d68e5961</value>
    </headers>
    <headers>
        <key>application</key>
        <value>demoIstemci</value>
    </headers>
    <body>
        <parameterGroupKey>ORGANIZATION_ORCHESTRATOR</parameterGroupKey>
        <parameterKey>LAST_NOTIFICATION_DELAY</parameterKey>
        <parameterValue>30</parameterValue>
        <effectiveStartDate>2017-07-20T00:00:00.000+03:00</effectiveStartDate>
        <marketType>NATURAL_GAS</marketType>
    </body>
</parameterSaveServiceRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<parameterSaveServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <parameterGetResponse>
            <key>LAST_NOTIFICATION_DELAY</key>
            <value>30</value>
            <description>Last Notification Time (day)</description>
            <effectiveStartDate>2017-07-20T00:00:00.000+03:00</effectiveStartDate>
        </parameterGetResponse>
    </body>
</parameterSaveServiceResponse>
Sample Json Request
{
        "headers": [
                {
                        "key": "application",
                        "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
                },
                {
                        "key": "transactionId",
                        "value": "d883f25c-413d-41e8-b695-9731186950dd"
                }
        ],
  "body": {
    "parameterGroupKey": "ORGANIZATION_ORCHESTRATOR",
    "parameterKey": "LAST_NOTIFICATION_DELAY",
    "parameterValue": "15",
    "marketType": "NATURAL_GAS",
    "effectiveStartDate": "2017-07-28T16:57:40.488Z"

  }
}
Sample Json Response
{
    "resultCode": "0",
    "resultDescription": "OK",
    "resultType": "SUCCESS",
    "body": {
        "parameterGetResponse": {
            "key": "LAST_NOTIFICATION_DELAY",
            "value": "15",
            "description": "Last Notification Time (day)",
            "effectiveStartDate": "2017-07-28T19:57:40.488+03:00"
        }
    }
}

3. Resmi Tatil Servisi

3.1. Resmi Tatil Kaydetme Servisi Nasıl Çağırılır?

Servis detaylarına buradan ulaşabilirsiniz.

Sample XML Request
<?xml version="1.0" encoding="UTF-8"?>
<publicHolidaySaveServiceRequest>
    <headers>
        <key>transactionId</key>
        <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
    </headers>
    <body>
        <publicHolidaySaveRequests>
            <publicHoliday>2018-04-23T00:00:00.000+03:00</publicHoliday>
            <effectiveStartDate>2018-01-01T00:00:00.000+03:00</effectiveStartDate>
            <effectiveEndDate>2018-12-31T00:00:00.000+03:00</effectiveEndDate>
            <publicHolidayDetailSaveRequests>
                <publicHolidayName>Tatil 1</publicHolidayName>
                <language>tr-TR</language>
            </publicHolidayDetailSaveRequests>
            <publicHolidayDetailSaveRequests>
                <publicHolidayName>Holiday 1</publicHolidayName>
                <language>en-US</language>
            </publicHolidayDetailSaveRequests>
        </publicHolidaySaveRequests>
    </body>
</publicHolidaySaveServiceRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<publicHolidaySaveServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <publicHolidayResponses>
            <publicHolidayId>2</publicHolidayId>
            <publicHoliday>2018-04-23T00:00:00.000+03:00</publicHoliday>
            <effectiveStartDate>2018-01-01T00:00:00.000+03:00</effectiveStartDate>
            <effectiveEndDate>2018-12-31T00:00:00.000+03:00</effectiveEndDate>
            <publicHolidayDetailResponses>
                <publicHolidayName>Tatil 1</publicHolidayName>
                <language>tr-TR</language>
            </publicHolidayDetailResponses>
            <publicHolidayDetailResponses>
                <publicHolidayName>Holiday 1</publicHolidayName>
                <language>en-US</language>
            </publicHolidayDetailResponses>
        </publicHolidayResponses>
    </body>
</publicHolidaySaveServiceResponse>
Sample Json Request
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
    "publicHolidaySaveRequests": [
      {
        "publicHoliday": "2018-04-23T00:00:00.000+03:00",
        "effectiveStartDate": "2018-01-01T00:00:00.000+03:00",
        "effectiveEndDate": "2018-12-31T00:00:00.000+03:00",
        "publicHolidayDetailSaveRequests": [
          {
            "publicHolidayName": "Tatil 1",
            "language": "tr-TR"
          },
          {
            "publicHolidayName": "Holiday 1",
            "language": "en-US"
          }
        ]
      }
    ]
  }
}
Sample Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "publicHolidayResponses": [
      {
        "publicHolidayId": 1,
        "publicHoliday": "2018-04-23T00:00:00.000+03:00",
        "effectiveStartDate": "2018-01-01T00:00:00.000+03:00",
        "effectiveEndDate": "2018-12-31T00:00:00.000+03:00",
        "publicHolidayDetailResponses": [
          {
            "publicHolidayName": "Tatil 1",
            "language": "tr-TR"
          },
          {
            "publicHolidayName": "Holiday 1",
            "language": "en-US"
          }
        ]
      }
    ]
  }
}

3.2. Resmi Tatil Silme Servisi Nasıl Çağırılır?

Servis detaylarına buradan ulaşabilirsiniz.

Sample XML Request
<?xml version="1.0" encoding="UTF-8"?>
<publicHolidayDeleteServiceRequest>
    <headers>
        <key>transactionId</key>
        <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
    </headers>
    <body>
        <publicHolidayId>1</publicHolidayId>
    </body>
</publicHolidayDeleteServiceRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<publicHolidayDeleteServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <publicHolidayResponse>
            <publicHolidayId>1</publicHolidayId>
            <publicHoliday>2018-04-23T00:00:00.000+03:00</publicHoliday>
            <effectiveStartDate>2018-01-01T00:00:00.000+03:00</effectiveStartDate>
            <effectiveEndDate>2018-12-31T00:00:00.000+03:00</effectiveEndDate>
            <publicHolidayDetailResponses>
                <publicHolidayName>Tatil 1</publicHolidayName>
                <language>tr-TR</language>
            </publicHolidayDetailResponses>
            <publicHolidayDetailResponses>
                <publicHolidayName>Holiday 1</publicHolidayName>
                <language>en-US</language>
            </publicHolidayDetailResponses>
        </publicHolidayResponse>
    </body>
</publicHolidayDeleteServiceResponse>
Sample Json Request
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
    "publicHolidayId": "1"
  }
}
Sample Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "publicHolidayResponse": {
      "publicHolidayId": 1,
      "publicHoliday": "2018-04-23T00:00:00.000+03:00",
      "effectiveStartDate": "2018-01-01T00:00:00.000+03:00",
      "effectiveEndDate": "2018-12-31T00:00:00.000+03:00",
      "publicHolidayDetailResponses": [
        {
          "publicHolidayName": "Tatil 1",
          "language": "tr-TR"
        },
        {
          "publicHolidayName": "Holiday 1",
          "language": "en-US"
        }
      ]
    }
  }
}

3.3. Resmi Tatil Listeleme Servisi Nasıl Çağırılır?

Servis detaylarına buradan ulaşabilirsiniz.

Sample XML Request
<?xml version="1.0" encoding="UTF-8"?>
<publicHolidayListServiceRequest>
    <headers>
        <key>transactionId</key>
        <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
    </headers>
    <body>
        <publicHolidayId>1</publicHolidayId>
    </body>
</publicHolidayListServiceRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<publicHolidayListServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <publicHolidayResponses>
            <publicHolidayId>1</publicHolidayId>
            <publicHoliday>2018-04-23T00:00:00.000+03:00</publicHoliday>
            <effectiveStartDate>2018-01-01T00:00:00.000+03:00</effectiveStartDate>
            <effectiveEndDate>2018-12-31T00:00:00.000+03:00</effectiveEndDate>
            <publicHolidayDetailResponses>
                <publicHolidayName>Tatil 1</publicHolidayName>
                <language>tr-TR</language>
            </publicHolidayDetailResponses>
            <publicHolidayDetailResponses>
                <publicHolidayName>Holiday 1</publicHolidayName>
                <language>en-US</language>
            </publicHolidayDetailResponses>
        </publicHolidayResponses>
    </body>
</publicHolidayListServiceResponse>
Sample Json Request
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
    "publicHolidayId": "1"
  }
}
Sample Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "publicHolidayResponses": [
      {
        "publicHolidayId": 1,
        "publicHoliday": "2018-04-23T00:00:00.000+03:00",
        "effectiveStartDate": "2018-01-01T00:00:00.000+03:00",
        "effectiveEndDate": "2018-12-31T00:00:00.000+03:00",
        "publicHolidayDetailResponses": [
          {
            "publicHolidayName": "Tatil 1",
            "language": "tr-TR"
          },
          {
            "publicHolidayName": "Holiday 1",
            "language": "en-US"
          }
        ]
      }
    ]
  }
}

3.4. Resmi Tatil Sorgulama Servisi Nasıl Çağırılır?

Servis detaylarına buradan ulaşabilirsiniz.

Sample XML Request
<?xml version="1.0" encoding="UTF-8"?>
<publicHolidayGetServiceRequest>
    <headers>
        <key>transactionId</key>
        <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
    </headers>
    <body>
        <publicHolidayGetRequests>
            <day>2018-04-23T00:00:00.000+03:00</day>
        </publicHolidayGetRequests>
    </body>
</publicHolidayGetServiceRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<publicHolidayGetServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <publicHolidayResponses>
            <publicHolidayId>1</publicHolidayId>
            <publicHoliday>2018-04-23T00:00:00.000+03:00</publicHoliday>
            <effectiveStartDate>2018-01-01T00:00:00.000+03:00</effectiveStartDate>
            <effectiveEndDate>2018-12-31T00:00:00.000+03:00</effectiveEndDate>
            <publicHolidayDetailResponses>
                <publicHolidayName>Tatil 1</publicHolidayName>
                <language>tr-TR</language>
            </publicHolidayDetailResponses>
            <publicHolidayDetailResponses>
                <publicHolidayName>Holiday 1</publicHolidayName>
                <language>en-US</language>
            </publicHolidayDetailResponses>
        </publicHolidayResponses>
    </body>
</publicHolidayGetServiceResponse>
Sample Json Request
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
    "publicHolidayGetRequests":[
      {
        "day": "2018-04-23T00:00:00.000+03:00"
      }
    ]
  }
}
Sample Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "publicHolidayResponses": [
      {
        "publicHolidayId": 1,
        "publicHoliday": "2018-04-23T00:00:00.000+03:00",
        "effectiveStartDate": "2018-01-01T00:00:00.000+03:00",
        "effectiveEndDate": "2018-12-31T00:00:00.000+03:00",
        "publicHolidayDetailResponses": [
          {
            "publicHolidayName": "Tatil 1",
            "language": "tr-TR"
          },
          {
            "publicHolidayName": "Holiday 1",
            "language": "en-US"
          }
        ]
      }
    ]
  }
}

4. Yardımcı Veri Servisi

4.1. Yardımcı Veri parametreler servisi nasıl çağrılır?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İsteği
<?xml version="1.0" encoding="UTF-8" ?>
<helperParameterGetRequest>
    <headers>
        <key>transactionId</key>
        <value>57a064d5-2eb3-4a0b-bc71-7679d68e5961</value>
    </headers>
    <headers>
        <key>application</key>
        <value>demoIstemci</value>
    </headers>
    <body>
    </body>
</helperParameterGetRequest>
Örnek XML Cevabı
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<helperDataGetServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <referenceListResponse>
            <key>city</key>
            <description>Şehir Bilgisi</description>
        </referenceListResponse>
        <referenceListResponse>
            <key>district</key>
            <description>İlçe Bilgisi</description>
        </referenceListResponse>
    </body>
</helperDataGetServiceResponse>
Örnek Json İsteği
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
  }
}
Örnek Json Cevabı
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "referenceListResponse": [
      {
        "key": "city",
        "description": "Şehir Bilgisi",
        "addition": null
      },
      {
        "key": "district",
        "description": "İlçe Bilgisi",
        "addition": null
      }
    ]
  }
}

5. Dizinler

5.1. Duyuru Listeleme Servisi

POST /announcement/get

5.1.1. Açıklama

Duyuru Listeleme Servisi

5.1.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

announcementGetServiceRequest

5.1.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

announcementGetServiceResponse

5.1.4. Kullanılanlar

  • application/json

  • application/xml

5.1.5. Üretilenler

  • application/json

  • application/xml

5.1.6. Etiketler

  • announcement

5.2. Duyuru Kaydetme Servisi

POST /announcement/save

5.2.1. Açıklama

Duyuru Kaydetme Servisi

5.2.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

announcementSaveServiceRequest

5.2.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

announcementSaveServiceResponse

5.2.4. Kullanılanlar

  • application/json

  • application/xml

5.2.5. Üretilenler

  • application/json

  • application/xml

5.2.6. Etiketler

  • announcement

5.3. Yardımcı Veri Servisi

POST /helper/get

5.3.1. Açıklama

Verilen parametrelere göre bulunan SQL ifadenin sonucunu döner.

5.3.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

helperDataGetRequest

5.3.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

helperDataGetServiceResponse

5.3.4. Kullanılanlar

  • application/json

  • application/xml

5.3.5. Üretilenler

  • application/json

  • application/xml

5.3.6. Etiketler

  • helper

5.4. Yardımcı Parametre Servisi

POST /helper/parameters

5.4.1. Açıklama

Parametreleri ve Açıklamalarını döner

5.4.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

helperParameterGetRequest

5.4.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

helperDataGetServiceResponse

5.4.4. Kullanılanlar

  • application/json

  • application/xml

5.4.5. Üretilenler

  • application/json

  • application/xml

5.4.6. Etiketler

  • helper

5.5. Operasyon Kodu Servisi

POST /operationcode/get

5.5.1. Açıklama

Operasyon Kodu Bilgilerini Döner

5.5.2. Parametreler

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

Body

body
opsiyonel

operationCodeGetRequest

5.5.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

operationCodeGetServiceResponse

5.5.4. Kullanılanlar

  • application/json

  • application/xml

5.5.5. Üretilenler

  • application/json

  • application/xml

5.5.6. Etiketler

  • operationcode

5.6. Operasyon Kod Gruplarını Alma Servisi

POST /operationcodegroup/get

5.6.1. Açıklama

Tüm Operasyon Grup Kodlarını Anlık Lokalizasyon Bilgisine Göre Getiren Servis

5.6.2. Parametreler

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

Body

body
opsiyonel

operationCodeGroupGetServiceRequest

5.6.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

operationCodeGroupGetServiceResponse

5.6.4. Kullanılanlar

  • application/json

  • application/xml

5.6.5. Üretilenler

  • application/json

  • application/xml

5.6.6. Etiketler

  • operationcodegroup

5.7. Operasyon Tarihçesi Servisi

POST /operationhistory/get

5.7.1. Açıklama

Operasyon Tarihçesi Sonuç Kümesi

5.7.2. Parametreler

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

Body

body
opsiyonel

operationHistoryGetRequest

5.7.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

operationHistoryGetServiceResponse

5.7.4. Kullanılanlar

  • application/json

  • application/xml

5.7.5. Üretilenler

  • application/json

  • application/xml

5.7.6. Etiketler

  • operationhistory

5.8. #{PARAMETER_DETAIL_NAME}

POST /parameter/detail

5.8.1. Açıklama

{PARAMETER_DETAIL_DESCRIPTION}

1.1. Parametreler

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

Body

body
opsiyonel

parameterGetRequest

1.2. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

parameterDetailServiceResponse

1.3. Kullanılanlar

  • application/json

  • application/xml

1.4. Üretilenler

  • application/json

  • application/xml

1.5. Etiketler

  • parameter

1.6. Parametre Servisi

POST /parameter/get

1.6.1. Açıklama

Verilen parametrelere göre anahtar ve değer ikilisini döner.

1.6.2. Parametreler

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

Body

body
opsiyonel

parameterGetRequest

1.6.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

parameterGetServiceResponse

1.6.4. Kullanılanlar

  • application/json

  • application/xml

1.6.5. Üretilenler

  • application/json

  • application/xml

1.6.6. Etiketler

  • parameter

1.7. #{PARAMETER_HISTORY_NAME}

POST /parameter/history

1.7.1. Açıklama

{PARAMETER_HISTORY_DESCRIPTION}

1.1. Parametreler

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

Body

body
opsiyonel

parameterHistoryServiceRequest

1.2. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

parameterHistoryServiceResponse

1.3. Kullanılanlar

  • application/json

  • application/xml

1.4. Üretilenler

  • application/json

  • application/xml

1.5. Etiketler

  • parameter

1.6. #{PARAMETER_SAVE_NAME}

POST /parameter/save

1.6.1. Açıklama

{PARAMETER_SAVE_DESCRIPTION}

1.1. Parametreler

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

Body

body
opsiyonel

parameterSaveServiceRequest

1.2. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

parameterSaveServiceResponse

1.3. Kullanılanlar

  • application/json

  • application/xml

1.4. Üretilenler

  • application/json

  • application/xml

1.5. Etiketler

  • parameter

1.6. Parametre Listesi Kaydetme

POST /parameter/save-list

1.6.1. Açıklama

Anahtar-Değer Listesi Kaydetme

1.6.2. Parametreler

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

Body

body
opsiyonel

parameterSaveListServiceRequest

1.6.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

parameterSaveServiceResponse

1.6.4. Kullanılanlar

  • application/json

  • application/xml

1.6.5. Üretilenler

  • application/json

  • application/xml

1.6.6. Etiketler

  • parameter

1.7. Resmi Tatil Silme Servisi

POST /public-holiday/delete

1.7.1. Açıklama

Resmi Tatil Silme Servisi

1.7.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

publicHolidayDeleteServiceRequest

1.7.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

publicHolidayDeleteServiceResponse

1.7.4. Kullanılanlar

  • application/json

  • application/xml

1.7.5. Üretilenler

  • application/json

  • application/xml

1.7.6. Etiketler

  • public-holiday

1.8. Resmi Tatil Sorgulama Servisi

POST /public-holiday/get

1.8.1. Açıklama

Resmi Tatil Sorgulama Servisi

1.8.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

publicHolidayGetServiceRequest

1.8.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

publicHolidayGetServiceResponse

1.8.4. Kullanılanlar

  • application/json

  • application/xml

1.8.5. Üretilenler

  • application/json

  • application/xml

1.8.6. Etiketler

  • public-holiday

1.9. Resmi Tatil Listeleme Servisi

POST /public-holiday/list

1.9.1. Açıklama

Resmi Tatil Listeleme Servisi

1.9.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

publicHolidayListServiceRequest

1.9.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

publicHolidayListServiceResponse

1.9.4. Kullanılanlar

  • application/json

  • application/xml

1.9.5. Üretilenler

  • application/json

  • application/xml

1.9.6. Etiketler

  • public-holiday

1.10. Resmi Tatil Kaydetme Servisi

POST /public-holiday/save

1.10.1. Açıklama

Resmi Tatil Kaydetme Servisi

1.10.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

publicHolidaySaveServiceRequest

1.10.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

publicHolidaySaveServiceResponse

1.10.4. Kullanılanlar

  • application/json

  • application/xml

1.10.5. Üretilenler

  • application/json

  • application/xml

1.10.6. Etiketler

  • public-holiday

6. Tanımlar

6.1. AnnouncementGetListResponseBody

Duyuru Listeleme Servis Cevabı

İsim Açıklama Şema

announcements
opsiyonel

< AnnouncementGetResponseBody > array

6.2. AnnouncementGetRequestBody

Duyuru Listeleme Servis İsteği

İsim Açıklama Şema

endDate
gerekli

Duyuru Listeleme Bitiş Tarihi

string(date-time)

language
gerekli

Duyuru Dili

string

startDate
gerekli

Duyuru Listeleme Başlangıç Tarihi

string(date-time)

6.3. AnnouncementGetResponseBody

Duyuru Listeleme Servis Cevabı

İsim Açıklama Şema

announcementId
gerekli

Duyuru Id

integer(int64)

createDate
gerekli

Duyuru Yaratılma Tarihi

string(date-time)

createUser
gerekli

Duyuruyu Oluşturan Kullanıcı

string

description
gerekli

Duyuru Açıklaması

string

language
gerekli

Duyuru Dili

string

subject
gerekli

Duyuru Konusu

string

6.4. AnnouncementSaveListRequestBody

Duyuru Kaydetme Servis İsteği

İsim Açıklama Şema

announcements
gerekli

< AnnouncementSaveRequestBody > array

6.5. AnnouncementSaveRequestBody

Duyuru Kaydetme Servis İsteği

İsim Açıklama Şema

description
gerekli

Duyuru Açıklaması

string

language
gerekli

Duyuru Dili

string

subject
gerekli

Duyuru Konusu

string

6.6. AnnouncementSaveResponseBody

Duyuru Kaydetme Servis Cevabı

Tip : object

6.7. Header

Header request bilgisini tutar.

İsim Açıklama Şema

key
opsiyonel

Header key bilgisini tutar.
Örnek : "transactionId"

string

value
opsiyonel

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

string

6.8. HelperDataGetListResponse

Sabit SQL ifadenin sonucu

İsim Açıklama Şema

referenceListResponse
opsiyonel

Sabit SQL ifade sonuç listesi

< HelperDataGetResponse > array

6.9. HelperDataGetRequestBody

Yardımcı Veri Servisi İsteği

İsim Açıklama Şema

marketType
gerekli

Piyasa Tipi

enum (NATURAL_GAS)

parameter
gerekli

= {PARAMETERS}

string

6.10. HelperDataGetResponse

Sabit SQL ifadenin sonucu

İsim Açıklama Şema

addition
opsiyonel

Sonuç kümesi ilave sütunu

string

description
opsiyonel

Sonuç kümesi ikinci sütunu

string

key
opsiyonel

Sonuç kümesi ilk sütunu

string

6.11. HelperParameterGetRequestBody

Yardımcı Parametre Servisi İsteği

Tip : object

6.12. OperationCodeGetListResponse

Operasyon Kodu Servis Sonucu

İsim Açıklama Şema

operationCodes
opsiyonel

Operasyon Kodu Servis Sonuç Kümesi

< OperationCodeResponse > array

6.13. OperationCodeGetRequestBody

Operasyon Kodu Servisi İsteği

İsim Açıklama Şema

operationCodeGroupId
opsiyonel

Operasyon Kod Grup Id

integer(int64)

6.14. OperationCodeGroupGetRequestBody

Operasyon Kod Grupları Alma İsteği

Tip : object

6.15. OperationCodeGroupGetResponseBody

Operasyon Kod Grupları Cevabı

İsim Açıklama Şema

operationCodeGroups
opsiyonel

< OperationCodeGroupResponse > array

6.16. OperationCodeGroupResponse

Operasyon Kod Grup

İsim Açıklama Şema

description
opsiyonel

Açıklama

string

id
opsiyonel

Benzersiz id.

integer(int64)

6.17. OperationCodeResponse

Operasyon Kodu Servis Sonucu

İsim Açıklama Şema

description
opsiyonel

Operasyon Açıklaması

string

id
opsiyonel

Operasyon Kodu

integer(int64)

6.18. OperationHistoryGetListResponse

Operasyon Tarihçesi Servis Sonucu

İsim Açıklama Şema

operationHistoryResponses
opsiyonel

Operasyon Tarihçesi Sonuç Listesi

< OperationHistoryResponse > array

queryInformation
opsiyonel

= {QUERYINFORMATION}

QueryInformation

6.19. OperationHistoryGetRequestBody

Operasyon Tarihçesi Servisi İsteği

İsim Açıklama Şema

endDate
opsiyonel

Operasyon Tarihçesi Bitiş Tarihi

string(date-time)

operationCodeGroupIds
opsiyonel

Operasyon Kod Grubu Idsi

< integer(int64) > array

operationCodeIds
opsiyonel

Operasyon Tarihçesi Operasyon Kodu Id

< integer(int64) > array

operationPriority
opsiyonel

Operasyon Tarihçesi Operasyon Önceliği

enum (INFO, WARNING, ERROR)

operationType
opsiyonel

Operasyon Tarihçesi Operasyon Tipi

enum (USER, SYSTEM)

organizationEic
opsiyonel

Operation History Organization Eic

string

range
opsiyonel

= {RANGE}

Range

referenceId
opsiyonel

Operasyon Tarihçesi Referans İd

string

startDate
opsiyonel

Operasyon Tarihçesi Başlangıç Tarihi

string(date-time)

userName
opsiyonel

Operasyon Tarihçesi Kullanıcı İsmi

string

6.20. OperationHistoryResponse

Operasyon Tarihçesi Servis Sonucu

İsim Açıklama Şema

description
opsiyonel

Operasyon Tarihçesi Açıklaması

string

id
opsiyonel

Operasyon Tarihçesi İd

integer(int64)

message
opsiyonel

Operasyon Tarihçesi Mesajı

string

modifyDate
opsiyonel

Operasyon Tarihçe Tarihi

string(date-time)

modifyUser
opsiyonel

Operasyon Tarihçesi Kullanıcı İsmi

string

operationCodeGroupResponse
opsiyonel

Operasyon Kod Grubu

OperationCodeGroupResponse

operationCodeResponse
opsiyonel

Operasyon Kodu

OperationCodeResponse

operationType
opsiyonel

Operasyon Tarihçesi Operasyon Tipi

enum (USER, SYSTEM)

organizationInformation
opsiyonel

İşlem Tarihçesi Temel Organizasyon Bilgileri

OrganizationInformation

priority
opsiyonel

Operasyon Tarihçesi Operasyon Önceliği

enum (INFO, WARNING, ERROR)

referenceId
opsiyonel

Operasyon Tarihçesi Referans İd

string

6.21. OrganizationInformation

Operasyon Tarihçesi Servis Sonucu

İsim Açıklama Şema

name
gerekli

İşlem Tarihçesi Organizasyon İsim Bilgisi

string

organizationEic
gerekli

İşlem Tarihçesi Organizasyon EIC Bilgisi

string

organizationId
gerekli

İşlem Tarihçesi Organizasyon İd Bilgisi

integer(int64)

shortName
gerekli

İşlem Tarihçesi Organizasyon Kısa İsim Bilgisi

string

6.22. ParameterDetailResponse

{PARAMETER_DETAIL_RESPONSE}

İsim Açıklama Şema

description
opsiyonel

Dönen Parametrenin Açıklaması

string

effectiveEndDate
opsiyonel

= {PARAMETER_EFFECTIVE_END_DATE}

string(date-time)

effectiveStartDate
opsiyonel

Parametre geçerlilik tarihi

string(date-time)

groupKey
opsiyonel

Parametre grubu anahtar değeri

string

key
opsiyonel

Parametre anahtar değeri

string

modifyUser
opsiyonel

= {MODIFY_USER}

string

value
opsiyonel

Sonuç kümesi değer sütunu

string

1.1. ParameterDetailResponseBody

{PARAMETER_DETAIL_RESPONSE_BODY}

İsim Açıklama Şema

parameterDetailResponses
opsiyonel

= {PARAMETER_DETAIL_RESPONSE}

< ParameterDetailResponse > array

1.1. ParameterGetListResponse

Parametre servis sonucu

İsim Açıklama Şema

parameterGetResponses
opsiyonel

Parametre servisi sonuç listesi

< ParameterGetResponse > array

1.2. ParameterGetRequestBody

Parametre servis isteği

İsim Açıklama Şema

effectiveDate
gerekli

Parametre geçerlilik tarihi

string(date-time)

marketType
opsiyonel

Piyasa Tipi

enum (NATURAL_GAS)

parameterGroupKey
gerekli

Parametre grubu anahtar değeri

string

parameterKey
opsiyonel

Parametre anahtar değeri

string

1.3. ParameterGetResponse

Parametre servis sonucu

İsim Açıklama Şema

description
opsiyonel

Dönen Parametrenin Açıklaması

string

effectiveStartDate
opsiyonel

Parametre geçerlilik tarihi

string(date-time)

key
opsiyonel

Parametre anahtar değeri

string

value
opsiyonel

Sonuç kümesi değer sütunu

string

1.4. ParameterHistoryRequestBody

{PARAMETER_HISTORY_REQUEST_BODY}

İsim Açıklama Şema

marketType
gerekli

Piyasa Tipi

enum (NATURAL_GAS)

parameterGroupKey
gerekli

Parametre grubu anahtar değeri

string

parameterKey
gerekli

Parametre anahtar değeri

string

1.1. ParameterHistoryResponseBody

{PARAMETER_HISTORY_RESPONSE_BODY}

İsim Açıklama Şema

parameterDetailResponses
opsiyonel

= {PARAMETER_DETAIL_RESPONSE}

< ParameterDetailResponse > array

1.1. ParameterSaveListRequestBody

Parametre Kaydetme Listesi Servisi

İsim Açıklama Şema

effectiveStartDate
gerekli

Parametre geçerlilik tarihi

string(date-time)

marketType
gerekli

Piyasa Tipi

enum (NATURAL_GAS)

parameterGroupKey
gerekli

Parametre grubu anahtar değeri

string

parameterTypes
gerekli

Parametre Tipi

< ParameterType > array

1.2. ParameterSaveRequestBody

{PARAMETER_SAVE_REQUEST_BODY}

İsim Açıklama Şema

effectiveStartDate
gerekli

Parametre geçerlilik tarihi

string(date-time)

marketType
gerekli

Piyasa Tipi

enum (NATURAL_GAS)

parameterGroupKey
gerekli

Parametre grubu anahtar değeri

string

parameterKey
gerekli

Parametre anahtar değeri

string

parameterValue
gerekli

= {PARAMETER_VALUE}

string

1.1. ParameterSaveResponseBody

{PARAMETER_SAVE_RESPONSE_BODY}

İsim Açıklama Şema

parameterGetResponse
opsiyonel

Parametre servisi sonuç listesi

ParameterGetResponse

1.1. ParameterType

Parametre Tipi

İsim Açıklama Şema

key
gerekli

Parametre Anahtarı

string

value
gerekli

Parametre Değeri

string

1.2. PublicHolidayDeleteRequestBody

Resmi Tatil Silme İstek İçeriği

İsim Açıklama Şema

publicHolidayId
gerekli

Resmi Tatil Id

integer(int64)

1.3. PublicHolidayDeleteResponseBody

Resmi Tatil Silme Cevap İçeriği

İsim Açıklama Şema

publicHolidayResponse
opsiyonel

PublicHolidayResponse

1.4. PublicHolidayDetailResponse

Resmi Tatil Detay Cevabı

İsim Açıklama Şema

language
gerekli

Dil

string

publicHolidayName
gerekli

Resmi Tatil Adı

string

1.5. PublicHolidayDetailSaveRequest

Resmi Tatil Detay Kaydetme İsteği

İsim Açıklama Şema

language
gerekli

Dil

string

publicHolidayName
gerekli

Resmi Tatil Adı

string

1.6. PublicHolidayGetRequest

Resmi Tatil Sorgulama İsteği

İsim Açıklama Şema

day
gerekli

Gün
Örnek : "2017-02-07T09:31:33.000+03:00"

string(date-time)

1.7. PublicHolidayGetRequestBody

Resmi Tatil Sorgulama İstek İçeriği

İsim Açıklama Şema

publicHolidayGetRequests
gerekli

< PublicHolidayGetRequest > array

1.8. PublicHolidayGetResponseBody

Resmi Tatil Sorgulama Cevap İçeriği

İsim Açıklama Şema

publicHolidayResponses
opsiyonel

< PublicHolidayResponse > array

1.9. PublicHolidayListRequestBody

Resmi Tatil Listeleme İstek İçeriği

İsim Açıklama Şema

publicHolidayId
opsiyonel

Resmi Tatil Id

integer(int64)

1.10. PublicHolidayListResponseBody

Resmi Tatil Listeleme Cevap İçeriği

İsim Açıklama Şema

publicHolidayResponses
opsiyonel

< PublicHolidayResponse > array

1.11. PublicHolidayResponse

PUBLIC_HOLIDAY_RESPONSE

İsim Açıklama Şema

effectiveEndDate
gerekli

Geçerlilik Bitiş Tarihi

string(date-time)

effectiveStartDate
gerekli

Geçerlilik Başlangıç Tarihi

string(date-time)

publicHoliday
gerekli

Resmi Tatil

string(date-time)

publicHolidayDetailResponses
gerekli

Resmi Tatil Detay Cevabı

< PublicHolidayDetailResponse > array

publicHolidayId
gerekli

Resmi Tatil Id

integer(int64)

1.12. PublicHolidaySaveRequest

Resmi Tatil Kaydetme İsteği

İsim Açıklama Şema

effectiveEndDate
opsiyonel

Geçerlilik Bitiş Tarihi
Örnek : "2017-02-07T09:31:33.000+03:00"

string(date-time)

effectiveStartDate
gerekli

Geçerlilik Başlangıç Tarihi
Örnek : "2017-02-07T09:31:33.000+03:00"

string(date-time)

publicHoliday
gerekli

Resmi Tatil
Örnek : "2017-02-07T09:31:33.000+03:00"

string(date-time)

publicHolidayDetailSaveRequests
gerekli

< PublicHolidayDetailSaveRequest > array

1.13. PublicHolidaySaveRequestBody

Resmi Tatil Kaydetme İstek İçeriği

İsim Açıklama Şema

publicHolidaySaveRequests
gerekli

< PublicHolidaySaveRequest > array

1.14. PublicHolidaySaveResponseBody

Resmi Tatil Kaydetme Cevap İçeriği

İsim Açıklama Şema

publicHolidayResponses
opsiyonel

< PublicHolidayResponse > array

1.15. QueryInformation

{QUERYINFORMATION}

İsim Açıklama Şema

begin
opsiyonel

= {QUERYINFORMATION_START}
Örnek : 1

integer(int32)

count
opsiyonel

= {QUERYINFORMATION_COUNT}
Örnek : 4444

integer(int32)

end
opsiyonel

= {QUERYINFORMATION_END}
Örnek : 10

integer(int32)

1.1. Range

{RANGE}

İsim Açıklama Şema

begin
opsiyonel

= {RANGE_START}
Örnek : 1

integer(int32)

end
opsiyonel

= {RANGE_END}
Örnek : 10

integer(int32)

1.1. announcementGetServiceRequest

Duyuru Listeleme Servis İsteği

İsim Açıklama Şema

body
opsiyonel

AnnouncementGetRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.2. announcementGetServiceResponse

Duyuru Listeleme Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

AnnouncementGetListResponseBody

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.3. announcementSaveServiceRequest

Duyuru Kaydetme Servis İsteği

İsim Açıklama Şema

body
gerekli

AnnouncementSaveListRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.4. announcementSaveServiceResponse

Duyuru Kaydetme Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

AnnouncementSaveResponseBody

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.5. helperDataGetRequest

Yardımcı Veri Servisi İsteği

İsim Açıklama Şema

body
gerekli

HelperDataGetRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.6. helperDataGetServiceResponse

Sabit SQL ifadenin sonucu

İsim Açıklama Şema

body
opsiyonel

HelperDataGetListResponse

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.7. helperParameterGetRequest

Yardımcı Parametre Servisi İsteği

İsim Açıklama Şema

body
gerekli

HelperParameterGetRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.8. operationCodeGetRequest

Operasyon Kodu Servisi İsteği

İsim Açıklama Şema

body
gerekli

OperationCodeGetRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.9. operationCodeGetServiceResponse

Operasyon Kodu Servis Sonucu

İsim Açıklama Şema

body
opsiyonel

OperationCodeGetListResponse

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.10. operationCodeGroupGetServiceRequest

Operasyon Kod Grupları Alma Servis İsteği

İsim Açıklama Şema

body
gerekli

OperationCodeGroupGetRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.11. operationCodeGroupGetServiceResponse

Operasyon Kod Grupları Alma Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

OperationCodeGroupGetResponseBody

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.12. operationHistoryGetRequest

Operasyon Tarihçesi Servisi İsteği

İsim Açıklama Şema

body
gerekli

OperationHistoryGetRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.13. operationHistoryGetServiceResponse

Operasyon Tarihçesi Servis Sonucu

İsim Açıklama Şema

body
opsiyonel

OperationHistoryGetListResponse

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.14. parameterDetailServiceResponse

{PARAMETER_DETAIL_SERVICE_RESPONSE}

İsim Açıklama Şema

body
opsiyonel

ParameterDetailResponseBody

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.1. parameterGetRequest

Parametre servis isteği

İsim Açıklama Şema

body
gerekli

ParameterGetRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.2. parameterGetServiceResponse

Parametre servis sonucu

İsim Açıklama Şema

body
opsiyonel

ParameterGetListResponse

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.3. parameterHistoryServiceRequest

{PARAMETER_HISTORY_SERVICE_REQUEST}

İsim Açıklama Şema

body
gerekli

ParameterHistoryRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.1. parameterHistoryServiceResponse

{PARAMETER_HISTORY_SERVICE_RESPONSE}

İsim Açıklama Şema

body
opsiyonel

ParameterHistoryResponseBody

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.1. parameterSaveListServiceRequest

Parametre Kaydetme Listesi Servis İsteği

İsim Açıklama Şema

body
opsiyonel

ParameterSaveListRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.2. parameterSaveServiceRequest

{PARAMETER_SAVE_SERVICE_REQUEST}

İsim Açıklama Şema

body
opsiyonel

ParameterSaveRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.1. parameterSaveServiceResponse

{PARAMETER_SAVE_SERVICE_RESPONSE}

İsim Açıklama Şema

body
opsiyonel

ParameterSaveResponseBody

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.1. publicHolidayDeleteServiceRequest

Resmi Tatil Silme Servis İsteği

İsim Açıklama Şema

body
gerekli

PublicHolidayDeleteRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.2. publicHolidayDeleteServiceResponse

Resmi Tatil Silme Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

PublicHolidayDeleteResponseBody

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.3. publicHolidayGetServiceRequest

Resmi Tatil Sorgulama Servis İsteği

İsim Açıklama Şema

body
gerekli

PublicHolidayGetRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.4. publicHolidayGetServiceResponse

Resmi Tatil Sorgulama Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

PublicHolidayGetResponseBody

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.5. publicHolidayListServiceRequest

Resmi Tatil Listeleme Servis İsteği

İsim Açıklama Şema

body
gerekli

PublicHolidayListRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.6. publicHolidayListServiceResponse

Resmi Tatil Listeleme Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

PublicHolidayListResponseBody

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

1.7. publicHolidaySaveServiceRequest

Resmi Tatil Kaydetme Servis İsteği

İsim Açıklama Şema

body
gerekli

PublicHolidaySaveRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

1.8. publicHolidaySaveServiceResponse

Resmi Tatil Kaydetme Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

PublicHolidaySaveResponseBody

resultCode
gerekli

0 başaralı diğer hallerde başarısız.
Örnek : "0"

string

resultDescription
gerekli

Başarılı durumlarda OK döner diğer hallerde hata açıklaması döner.
Örnek : "OK"

string

resultType
gerekli

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

Başarılı isteklerde SUCCESS , iş kuralına takıldığında BUSINESSERROR , yetki hatasına takılırsa SECURITYERROR, diğer hatalar için SYSTEMERROR .
Örnek : "Transaction Id"

string

7. Operasyon Kod Servisi

7.1. Operasyon Kodu servisi nasıl çağrılır?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İsteği
<?xml version="1.0" encoding="UTF-8" ?>
<operationCodeGetRequest>
    <headers>
        <key>transactionId</key>
        <value>57a064d5-2eb3-4a0b-bc71-7679d68e5961</value>
    </headers>
    <headers>
        <key>application</key>
        <value>demoIstemci</value>
    </headers>
    <body>
    </body>
</operationCodeGetRequest>
Örnek XML Cevabı
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operationCodeGetServiceResponse>
    <resultCode>0</resultCode>
    <resultDescription>OK</resultDescription>
    <resultType>SUCCESS</resultType>
    <body>
        <operationCodes>
            <id>PARAMETER_KEY_1</id>
            <description>Operasyon Tarih Kayıt</description>
        </operationCodes>
    </body>
</operationCodeGetServiceResponse>
Örnek Json İsteği
{
        "headers": [
                {
                        "key": "application",
                        "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
                },
                {
                        "key": "transactionId",
                        "value": "d883f25c-413d-41e8-b695-9731186950dd"
                }
        ],
        "body": {
        }
}
Örnek Json Cevabı
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "operationCodes": [
      {
        "id": 1,
        "description": "Operasyon Tarih Kayıt"
      }
    ]
  }
}

8. Operasyon Tarihçesi Servisi

8.1. Operasyon Tarihçesi servisi nasıl çağrılır?

Servis parametre detaylarına buradan erişebilirsiniz.

Örnek XML İsteği
<?xml version="1.0" encoding="UTF-8" ?>
<operationHistoryGetRequest>
        <headers>
                <key>transactionId</key>
                <value>57a064d5-2eb3-4a0b-bc71-7679d68e5961</value>
        </headers>
        <headers>
                <key>application</key>
                <value>demoIstemci</value>
        </headers>
        <body>
                <userName>demo</userName>
                <operationCode>1</operationCode>
                <operationType>USER</operationType>
                <organizationEic>23</organizationEic>
        </body>
</operationHistoryGetRequest>
Örnek XML Cevabı
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operationHistoryGetServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS</resultType>
        <body>
                <operationHistoryListResponse>
                        <id>1</id>
                        <organizationEic>23</organizationEic>
                        <priority>INFO</priority>
                        <operationType>USER</operationType>
                        <operationCode>1</operationCode>
                        <description>YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir.</description>
                </operationHistoryListResponse>
                <operationHistoryListResponse>
                        <id>2</id>
                        <organizationEic>23</organizationEic>
                        <priority>INFO</priority>
                        <operationType>USER</operationType>
                        <operationCode>1</operationCode>
                        <description>YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir.</description>
                </operationHistoryListResponse>
                <operationHistoryListResponse>
                        <id>3</id>
                        <organizationEic>23</organizationEic>
                        <priority>INFO</priority>
                        <operationType>USER</operationType>
                        <operationCode>1</operationCode>
                        <description>YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir.</description>
                </operationHistoryListResponse>
                <operationHistoryListResponse>
                        <id>4</id>
                        <organizationEic>23</organizationEic>
                        <priority>INFO</priority>
                        <operationType>USER</operationType>
                        <operationCode>1</operationCode>
                        <description>YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir.</description>
                </operationHistoryListResponse>
                <operationHistoryListResponse>
                        <id>5</id>
                        <organizationEic>23</organizationEic>
                        <priority>INFO</priority>
                        <operationType>USER</operationType>
                        <operationCode>1</operationCode>
                        <description>YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir.</description>
                </operationHistoryListResponse>
        </body>
</operationHistoryGetServiceResponse>
Örnek Json İsteği
{
  "headers": [
    {
      "key": "application",
      "value": "528969ea-d7f6-440a-b020-e78a8d531a32"
    },
    {
      "key": "transactionId",
      "value": "d883f25c-413d-41e8-b695-9731186950dd"
    }
  ],
  "body": {
                                  "startDate": null,
                        "endDate": null,
                "userName": "demo",
                "operationCode": "1",
                "operationType": "USER",
                "organizationEic": "23"
  }
}
Örnek Json Cevabı
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "body": {
    "operationHistoryListResponse": [
      {
        "id": 5,
        "organizationEic": "23",
        "priority": "INFO",
        "operationType": "USER",
        "referenceId": null,
        "operationCode": 1,
        "description": "YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir."
      },
      {
        "id": 4,
        "organizationEic": "23",
        "priority": "INFO",
        "operationType": "USER",
        "referenceId": null,
        "operationCode": 1,
        "description": "YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir."
      },
      {
        "id": 3,
        "organizationEic": "23",
        "priority": "INFO",
        "operationType": "USER",
        "referenceId": null,
        "operationCode": 1,
        "description": "YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir."
      },
      {
        "id": 2,
        "organizationEic": "23",
        "priority": "INFO",
        "operationType": "USER",
        "referenceId": null,
        "operationCode": 1,
        "description": "YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir."
      },
      {
        "id": 1,
        "organizationEic": "23",
        "priority": "INFO",
        "operationType": "USER",
        "referenceId": null,
        "operationCode": 1,
        "description": "YUCEL kullanıcısı DATE tarihinde DATE no lu kaydı kaydetmiştir."
      }
    ]
  }
}