Overview

Version information

Version : v1

URI scheme

Host : ${deployenv}.epias.com.tr
BasePath : /stp-orchestrator-trading-engine/rest
Schemes : HTTPS

Tags

  • bid

  • contract

  • contract-conf

  • contract-gate

  • contract-status

  • market-price

  • match

  • payment

  • trade-engine

  • trading

Döküman Hakkında

Bu dökümanda Piyasa Motoru 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://testcas.epias.com.tr) etiket alınarak gönderilmelidir.

Uygulama Servis Çağrımı

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

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

Ticket Granting Ticket (TGT) Oluşturma

TGT oluşturmak için gerçek ortam https://cas.epias.com.tr/cas/v1/tickets?format=text yada test ortamı https://testcas.epias.com.tr/cas/v1/tickets?format=text adresine aşağıdaki değerleri POST metodu ile göndermeniz gerekmektedir. 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://testcas.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://stp.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://stp.epias.com.tr gerçek ortam için https://teststp.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+03:00",
      "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+03:00",
            "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+03:00",
            "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+03:00",
            "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"}

Servis Detayları

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

1. Teklif Servisleri

1.1. Teklif Oluşturma Servisi Kullanımı

Teklif oluşturmak için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<bidSaveServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <contractName>string</contractName>
                <price>0</price>
                <quantity>0</quantity>
                <bidType>string</bidType>
                <bidStatus>string</bidStatus>
                <direction>string</direction>
                <expireTime>2017-11-30T07:41:41.390+03:00</expireTime>
                <pointName>string</pointName>
                <bidProcessName>string</bidProcessName>
        </body>
</bidSaveServiceRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "contractName": "string",
    "price": 0,
    "quantity": 0,
    "bidType": "string",
    "bidStatus": "string",
    "direction": "string",
    "expireTime": "2018-02-20T19:30:33.000+03:00",
    "pointName": "string",
    "bidProcessName": "string"
  }
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<bidSaveServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <bidResponse>
                        <id>string</id>
                </bidResponse>
        </body>
</bidSaveServiceResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "bidResponse": {
      "id": "string"
    }
  }
}

1.2. Teklif Güncelleme Servisi Kullanımı

Teklif güncellemek için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<bidUpdateServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <bidId>string</bidId>
                <price>0</price>
                <quantity>0</quantity>
                <bidStatus>string</bidStatus>
        </body>
</bidUpdateServiceRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "bidId": "string",
    "price": 0,
    "quantity": 0,
    "bidStatus": "string"
  }
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<bidUpdateServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <bidResponse>
                        <id>string</id>
                </bidResponse>
        </body>
</bidUpdateServiceResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "bidResponse": {
      "id": "string"
    }
  }
}

1.3. Teklif İptal Etme Servisi Kullanımı

Teklif iptal etmek için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<bidCancelServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <bidId>string</bidId>
        </body>
</bidCancelServiceRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "bidId": "string"
  }
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<bidCancelServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <bidResponse>
                        <id>string</id>
                </bidResponse>
        </body>
</bidCancelServiceResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "bidResponse": {
      "id": "string"
    }
  }
}

2. Kontrat Servisleri

2.1. Kontrat Oluşturma Servisi Kullanımı

Kontrat oluşturmak için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<contractSaveServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <contractTypeName>string</contractTypeName>
                <gasDayDate>2017-11-30T07:51:26.997+03:00</gasDayDate>
                <quantity>0</quantity>
                <directionName>string</directionName>
                <physicalPointIds>0</physicalPointIds>
        </body>
</contractSaveServiceRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "contractTypeName": "string",
    "gasDayDate": "2017-11-30T07:50:08.873+03:00",
    "quantity": 0,
    "directionName": "string",
    "physicalPointIds": [
      0
    ]
  }
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<contractSaveServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <contractName>string</contractName>
                <contractType>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </contractType>
                <contractStatus>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </contractStatus>
                <gasDay>
                        <gasDayId>0</gasDayId>
                        <registrationPeriodId>0</registrationPeriodId>
                        <gasDayDate>2017-11-30T07:51:37.097+03:00</gasDayDate>
                        <gasDeliveryStartDate>2017-11-30T07:51:37.097+03:00</gasDeliveryStartDate>
                        <gasDeliveryEndDate>2017-11-30T07:51:37.097+03:00</gasDeliveryEndDate>
                </gasDay>
                <quantity>0</quantity>
                <direction>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </direction>
                <createDate>2017-11-30T07:51:37.097+03:00</createDate>
                <activationDate>2017-11-30T07:51:37.097+03:00</activationDate>
                <closeDate>2017-11-30T07:51:37.097+03:00</closeDate>
                <physicalPointIds>0</physicalPointIds>
        </body>
</contractSaveServiceResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "contractName": "string",
    "contractType": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    },
    "contractStatus": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    },
    "gasDay": {
      "gasDayId": 0,
      "registrationPeriodId": 0,
      "gasDayDate": "2017-11-30T07:50:08.912+03:00",
      "gasDeliveryStartDate": "2017-11-30T07:50:08.912+03:00",
      "gasDeliveryEndDate": "2017-11-30T07:50:08.912+03:00"
    },
    "quantity": 0,
    "direction": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    },
    "createDate": "2017-11-30T07:50:08.912+03:00",
    "activationDate": "2017-11-30T07:50:08.912+03:00",
    "closeDate": "2017-11-30T07:50:08.912+03:00",
    "physicalPointIds": [
      0
    ]
  }
}

2.2. Kontrat Sorgulama Servisi Kullanımı

Kontrat sorgulamak için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<contractGetServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <contractName>string</contractName>
        </body>
</contractGetServiceRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "contractName": "string"
  }
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<contractGetServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <contractName>string</contractName>
                <contractType>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </contractType>
                <contractStatus>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </contractStatus>
                <gasDay>
                        <gasDayId>0</gasDayId>
                        <registrationPeriodId>0</registrationPeriodId>
                        <gasDayDate>2017-11-30T07:51:13.578+03:00</gasDayDate>
                        <gasDeliveryStartDate>2017-11-30T07:51:13.578+03:00</gasDeliveryStartDate>
                        <gasDeliveryEndDate>2017-11-30T07:51:13.578+03:00</gasDeliveryEndDate>
                </gasDay>
                <quantity>0</quantity>
                <direction>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </direction>
                <createDate>2017-11-30T07:51:13.578+03:00</createDate>
                <activationDate>2017-11-30T07:51:13.578+03:00</activationDate>
                <closeDate>2017-11-30T07:51:13.578+03:00</closeDate>
                <physicalPointIds>0</physicalPointIds>
        </body>
</contractGetServiceResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "contractName": "string",
    "contractType": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    },
    "contractStatus": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    },
    "gasDay": {
      "gasDayId": 0,
      "registrationPeriodId": 0,
      "gasDayDate": "2017-11-30T07:49:51.382+03:00",
      "gasDeliveryStartDate": "2017-11-30T07:49:51.382+03:00",
      "gasDeliveryEndDate": "2017-11-30T07:49:51.382+03:00"
    },
    "quantity": 0,
    "direction": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    },
    "createDate": "2017-11-30T07:49:51.382+03:00",
    "activationDate": "2017-11-30T07:49:51.382+03:00",
    "closeDate": "2017-11-30T07:49:51.382+03:00",
    "physicalPointIds": [
      0
    ]
  }
}

2.3. Aktif Kontrat Derinliği Servisi Kullanımı

Aktif kontrat derinliğini öğrenmek için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<contractDepthServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <contractName>string</contractName>
        </body>
</contractDepthServiceRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "contractName": "string"
  }
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<ContractDepthServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <contractBuyDepths>
                        <price>0</price>
                        <amount>0</amount>
                </contractBuyDepths>
                <contractSellDepths>
                        <price>0</price>
                        <amount>0</amount>
                </contractSellDepths>
        </body>
</ContractDepthServiceResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "contractBuyDepths": [
      {
        "price": 0,
        "amount": 0
      }
    ],
    "contractSellDepths": [
      {
        "price": 0,
        "amount": 0
      }
    ]
  }
}

2.4. Aktif Kontrat Derinliği Özeti Servisi Kullanımı

Aktif kontrat derinlik özetini öğrenmek için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<contractDepthServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <contractName>string</contractName>
        </body>
</contractDepthServiceRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "contractName": "string"
  }
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<ContractDepthSummaryServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <contractDepthSummaryResponses>
                        <price>0</price>
                        <quantity>0</quantity>
                        <bidStatus>
                                <name>string</name>
                                <localization>
                                        <language>string</language>
                                        <text>string</text>
                                </localization>
                        </bidStatus>
                        <organizationId>0</organizationId>
                        <organization>
                                <value>string</value>
                                <text>string</text>
                        </organization>
                        <lastMatchingsQuantityAverage>0</lastMatchingsQuantityAverage>
                        <lastMatchingsPriceAverage>0</lastMatchingsPriceAverage>
                        <direction>
                                <name>string</name>
                                <localization>
                                        <language>string</language>
                                        <text>string</text>
                                </localization>
                        </direction>
                        <createDate>2017-11-30T07:52:34.709+03:00</createDate>
                        <bidState>
                                <value>string</value>
                                <text>string</text>
                        </bidState>
                </contractDepthSummaryResponses>
        </body>
</ContractDepthSummaryServiceResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "contractDepthSummaryResponses": [
      {
        "price": 0,
        "quantity": 0,
        "bidStatus": {
          "name": "string",
          "localization": {
            "language": "string",
            "text": "string"
          }
        },
        "organizationId": 0,
        "organization": {
          "value": "string",
          "text": "string"
        },
        "lastMatchingsQuantityAverage": 0,
        "lastMatchingsPriceAverage": 0,
        "direction": {
          "name": "string",
          "localization": {
            "language": "string",
            "text": "string"
          }
        },
        "createDate": "2017-11-30T07:48:26.661+03:00",
        "bidState": {
          "value": "string",
          "text": "string"
        }
      }
    ]
  }
}

2.5. Aktif Kontrat Eşleşmeleri Servisi Kullanımı

Aktif kontrat eşleşmelerini öğrenmek için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<activeContractMatchingRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <contractNames>string</contractNames>
        </body>
</activeContractMatchingRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "contractNames": [
      "string"
    ]
  }
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<activeContractMatchingResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <matchings>
                        <matchId>string</matchId>
                        <contract>string</contract>
                        <price>0</price>
                        <quantity>0</quantity>
                        <matchStatus>string</matchStatus>
                        <matchingTime>2017-11-30T07:52:59.443+03:00</matchingTime>
                        <pointName>string</pointName>
                        <myOwnMatching>false</myOwnMatching>
                </matchings>
        </body>
</activeContractMatchingResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "matchings": [
      {
        "matchId": "string",
        "contract": "string",
        "price": 0,
        "quantity": 0,
        "matchStatus": "string",
        "matchingTime": "2017-11-30T07:48:42.156+03:00",
        "pointName": "string",
        "myOwnMatching": false
      }
    ]
  }
}

2.6. Bölgesel Aktif Kontratlar Servisi Kullanımı

Bölgesel aktif kontratları öğrenmek için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<contractRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
        </body>
</contractRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {}
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<regionalContractResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <contracts>
                        <deliveryDay>2017-11-30T07:53:18.219+03:00</deliveryDay>
                        <name>string</name>
                        <bestAmountPriceBuying>
                                <price>0</price>
                                <amount>0</amount>
                        </bestAmountPriceBuying>
                        <bestAmountPriceSelling>
                                <price>0</price>
                                <amount>0</amount>
                        </bestAmountPriceSelling>
                        <status>
                                <value>string</value>
                                <text>string</text>
                        </status>
                        <closingTime>2017-11-30T07:53:18.219+03:00</closingTime>
                        <activationTime>2017-11-30T07:53:18.219+03:00</activationTime>
                        <type>
                                <value>string</value>
                                <text>string</text>
                        </type>
                        <totalAmount>0</totalAmount>
                        <remainingAmount>0</remainingAmount>
                        <locations>string</locations>
                        <direction>string</direction>
                </contracts>
        </body>
</regionalContractResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "contracts": [
      {
        "deliveryDay": "2017-11-30T07:49:02.334+03:00",
        "name": "string",
        "bestAmountPriceBuying": {
          "price": 0,
          "amount": 0
        },
        "bestAmountPriceSelling": {
          "price": 0,
          "amount": 0
        },
        "status": {
          "value": "string",
          "text": "string"
        },
        "closingTime": "2017-11-30T07:49:02.334+03:00",
        "activationTime": "2017-11-30T07:49:02.334+03:00",
        "type": {
          "value": "string",
          "text": "string"
        },
        "totalAmount": 0,
        "remainingAmount": 0,
        "locations": [
          "string"
        ],
        "direction": "string"
      }
    ]
  }
}

2.7. Standart Aktif Kontratlar Servisi Kullanımı

Standart aktif kontratları öğrenmek için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<contractRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
        </body>
</contractRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {}
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<contractResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <contracts>
                        <deliveryDay>2017-11-30T07:53:39.103+03:00</deliveryDay>
                        <name>string</name>
                        <bestAmountPriceBuying>
                                <price>0</price>
                                <amount>0</amount>
                        </bestAmountPriceBuying>
                        <bestAmountPriceSelling>
                                <price>0</price>
                                <amount>0</amount>
                        </bestAmountPriceSelling>
                        <status>
                                <value>string</value>
                                <text>string</text>
                        </status>
                        <closingTime>2017-11-30T07:53:39.103+03:00</closingTime>
                        <activationTime>2017-11-30T07:53:39.103+03:00</activationTime>
                        <type>
                                <value>string</value>
                                <text>string</text>
                        </type>
                        <highestMatchingPrice>0</highestMatchingPrice>
                        <lastMatchingPrice>0</lastMatchingPrice>
                        <lastMatchingPriceDirection>UP</lastMatchingPriceDirection>
                        <weightedAverage>0</weightedAverage>
                        <weightedAverageDirection>UP</weightedAverageDirection>
                        <gasDay>2017-11-30T07:53:39.103+03:00</gasDay>
                </contracts>
        </body>
</contractResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "contracts": [
      {
        "deliveryDay": "2017-11-30T07:49:18.625+03:00",
        "name": "string",
        "bestAmountPriceBuying": {
          "price": 0,
          "amount": 0
        },
        "bestAmountPriceSelling": {
          "price": 0,
          "amount": 0
        },
        "status": {
          "value": "string",
          "text": "string"
        },
        "closingTime": "2018-02-20T19:30:33.000+03:00",
        "activationTime": "2017-11-30T07:49:18.625+03:00",
        "type": {
          "value": "string",
          "text": "string"
        },
        "highestMatchingPrice": 0,
        "lastMatchingPrice": 0,
        "lastMatchingPriceDirection": "UP",
        "weightedAverage": 0,
        "weightedAverageDirection": "UP",
        "gasDay": "2017-11-30T07:49:18.625+03:00"
      }
    ]
  }
}

3. Kontrat Konfigürasyon Servisleri

3.1. Kontrat Konfigürasyon Kaydetme Servisi Kullanımı

Kontrat konfigürasyonu kaydetmek için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<contractConfigurationSaveServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <contractName>string</contractName>
                <gateList>
                        <contractGateId>0</contractGateId>
                        <contractGateTypeName>string</contractGateTypeName>
                        <startDate>2017-11-30T07:47:18.733+03:00</startDate>
                        <endDate>2017-11-30T07:47:18.733+03:00</endDate>
                        <gateStatusName>string</gateStatusName>
                </gateList>
                <dapScopeDate>2017-11-30T07:47:18.733+03:00</dapScopeDate>
                <dapFinalDate>2017-11-30T07:47:18.733+03:00</dapFinalDate>
                <grpScopeDate>2017-11-30T07:47:18.733+03:00</grpScopeDate>
                <grpFinalDate>2017-11-30T07:47:18.733+03:00</grpFinalDate>
                <lqa>0</lqa>
                <lpa>0</lpa>
                <objectionTime>0</objectionTime>
                <marketMaxQuantity>0</marketMaxQuantity>
                <marketMinQuantity>0</marketMinQuantity>
                <marketCeilingPrice>0</marketCeilingPrice>
                <marketBasePrice>0</marketBasePrice>
                <transmissionMaxQuantity>0</transmissionMaxQuantity>
                <transmissionMinQuantity>0</transmissionMinQuantity>
                <ceilingCoefficient>0</ceilingCoefficient>
                <baseCoefficient>0</baseCoefficient>
                <average>0</average>
                <transmissionCeilingPriceFormula>string</transmissionCeilingPriceFormula>
                <transmissionCeilingPrice>0</transmissionCeilingPrice>
                <transmissionBasePriceFormula>string</transmissionBasePriceFormula>
                <transmissionBasePrice>0</transmissionBasePrice>
                <nbpOpenTime>0</nbpOpenTime>
                <modifyUser>string</modifyUser>
        </body>
</contractConfigurationSaveServiceRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "contractName": "string",
    "gateList": [
      {
        "contractGateId": 0,
        "contractGateTypeName": "string",
        "startDate": "2017-11-30T07:46:21.790+03:00",
        "endDate": "2017-11-30T07:46:21.790+03:00",
        "gateStatusName": "string"
      }
    ],
    "dapScopeDate": "2017-11-30T07:46:21.790+03:00",
    "dapFinalDate": "2017-11-30T07:46:21.790+03:00",
    "grpScopeDate": "2017-11-30T07:46:21.790+03:00",
    "grpFinalDate": "2017-11-30T07:46:21.790+03:00",
    "lqa": 0,
    "lpa": 0,
    "objectionTime": 0,
    "marketMaxQuantity": 0,
    "marketMinQuantity": 0,
    "marketCeilingPrice": 0,
    "marketBasePrice": 0,
    "transmissionMaxQuantity": 0,
    "transmissionMinQuantity": 0,
    "ceilingCoefficient": 0,
    "baseCoefficient": 0,
    "average": 0,
    "transmissionCeilingPriceFormula": "string",
    "transmissionCeilingPrice": 0,
    "transmissionBasePriceFormula": "string",
    "transmissionBasePrice": 0,
    "nbpOpenTime": 0,
    "modifyUser": "string"
  }
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<contractConfigurationSaveServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
        </body>
</contractConfigurationSaveServiceResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {}
}

3.2. Kontrat Konfigürasyon Sorgulama Servisi Kullanımı

Kontrat konfigürasyonu sorgulamak için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<contractConfigurationGetServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <contractName>string</contractName>
        </body>
</contractConfigurationGetServiceRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "contractName": "string"
  }
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<contractConfigurationGetServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <contractConfId>0</contractConfId>
                <dapScopeDate>2017-11-30T07:46:58.406+03:00</dapScopeDate>
                <dapFinalDate>2017-11-30T07:46:58.406+03:00</dapFinalDate>
                <grpScopeDate>2017-11-30T07:46:58.406+03:00</grpScopeDate>
                <grpFinalDate>2017-11-30T07:46:58.406+03:00</grpFinalDate>
                <lqa>0</lqa>
                <lpa>0</lpa>
                <objectionTime>0</objectionTime>
                <marketMaxQuantity>0</marketMaxQuantity>
                <marketMinQuantity>0</marketMinQuantity>
                <marketCeilingPrice>0</marketCeilingPrice>
                <marketBasePrice>0</marketBasePrice>
                <transmissionMaxQuantity>0</transmissionMaxQuantity>
                <transmissionMinQuantity>0</transmissionMinQuantity>
                <ceilingCoefficient>0</ceilingCoefficient>
                <baseCoefficient>0</baseCoefficient>
                <retrospectiveAverage>0</retrospectiveAverage>
                <transmissionCeilingPriceFormula>string</transmissionCeilingPriceFormula>
                <transmissionCeilingPrice>0</transmissionCeilingPrice>
                <transmissionBasePriceFormula>string</transmissionBasePriceFormula>
                <transmissionBasePrice>0</transmissionBasePrice>
                <nbpOpenTime>0</nbpOpenTime>
                <gateList>
                        <contractGateId>0</contractGateId>
                        <gateTypeResponse>
                                <name>string</name>
                                <localization>
                                        <language>string</language>
                                        <text>string</text>
                                </localization>
                        </gateTypeResponse>
                        <startDate>2017-11-30T07:46:58.406+03:00</startDate>
                        <endDate>2017-11-30T07:46:58.406+03:00</endDate>
                        <gateStatusResponse>
                                <name>string</name>
                                <localization>
                                        <language>string</language>
                                        <text>string</text>
                                </localization>
                        </gateStatusResponse>
                        <contractName>string</contractName>
                        <quantity>0</quantity>
                        <announcementDate>2017-11-30T07:46:58.406+03:00</announcementDate>
                        <directionResponse>
                                <name>string</name>
                                <localization>
                                        <language>string</language>
                                        <text>string</text>
                                </localization>
                        </directionResponse>
                </gateList>
        </body>
</contractConfigurationGetServiceResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "contractConfId": 0,
    "dapScopeDate": "2017-11-30T07:45:58.596+03:00",
    "dapFinalDate": "2017-11-30T07:45:58.596+03:00",
    "grpScopeDate": "2017-11-30T07:45:58.596+03:00",
    "grpFinalDate": "2017-11-30T07:45:58.596+03:00",
    "lqa": 0,
    "lpa": 0,
    "objectionTime": 0,
    "marketMaxQuantity": 0,
    "marketMinQuantity": 0,
    "marketCeilingPrice": 0,
    "marketBasePrice": 0,
    "transmissionMaxQuantity": 0,
    "transmissionMinQuantity": 0,
    "ceilingCoefficient": 0,
    "baseCoefficient": 0,
    "retrospectiveAverage": 0,
    "transmissionCeilingPriceFormula": "string",
    "transmissionCeilingPrice": 0,
    "transmissionBasePriceFormula": "string",
    "transmissionBasePrice": 0,
    "nbpOpenTime": 0,
    "gateList": [
      {
        "contractGateId": 0,
        "gateTypeResponse": {
          "name": "string",
          "localization": {
            "language": "string",
            "text": "string"
          }
        },
        "startDate": "2017-11-30T07:45:58.596+03:00",
        "endDate": "2017-11-30T07:45:58.596+03:00",
        "gateStatusResponse": {
          "name": "string",
          "localization": {
            "language": "string",
            "text": "string"
          }
        },
        "contractName": "string",
        "quantity": 0,
        "announcementDate": "2017-11-30T07:45:58.596+03:00",
        "directionResponse": {
          "name": "string",
          "localization": {
            "language": "string",
            "text": "string"
          }
        }
      }
    ]
  }
}

4. Contract Gate Services

4.1. How to call Contract Gate Change Status Service?

You can check service details from here .

Sample XML Request
<?xml version="1.0" encoding="UTF-8"?>
<contractGateChangeStatusServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <gateId>0</gateId>
                <gateStatusName>string</gateStatusName>
        </body>
</contractGateChangeStatusServiceRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<contractGateSaveServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <contractGateId>0</contractGateId>
                <gateTypeResponse>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </gateTypeResponse>
                <startDate>2017-11-30T07:44:32.174+03:00</startDate>
                <endDate>2017-11-30T07:44:32.174+03:00</endDate>
                <gateStatusResponse>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </gateStatusResponse>
                <contractName>string</contractName>
                <quantity>0</quantity>
                <announcementDate>2017-11-30T07:44:32.174+03:00</announcementDate>
                <directionResponse>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </directionResponse>
        </body>
</contractGateSaveServiceResponse>
Sample Json Request
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "gateId": 0,
    "gateStatusName": "string"
  }
}
Sample Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "contractGateId": 0,
    "gateTypeResponse": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    },
    "startDate": "2017-11-30T07:42:56.171+03:00",
    "endDate": "2017-11-30T07:42:56.171+03:00",
    "gateStatusResponse": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    },
    "contractName": "string",
    "quantity": 0,
    "announcementDate": "2017-11-30T07:42:56.171+03:00",
    "directionResponse": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    }
  }
}

4.2. How to call Contract Gate Update Service?

You can check service details from here .

Sample XML Request
<?xml version="1.0" encoding="UTF-8"?>
<contractGateUpdateServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <gateId>0</gateId>
                <startDate>2017-11-30T07:45:05.574+03:00</startDate>
                <endDate>2017-11-30T07:45:05.574+03:00</endDate>
        </body>
</contractGateUpdateServiceRequest>
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<contractGateSaveServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <contractGateId>0</contractGateId>
                <gateTypeResponse>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </gateTypeResponse>
                <startDate>2017-11-30T07:45:18.585+03:00</startDate>
                <endDate>2017-11-30T07:45:18.585+03:00</endDate>
                <gateStatusResponse>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </gateStatusResponse>
                <contractName>string</contractName>
                <quantity>0</quantity>
                <announcementDate>2017-11-30T07:45:18.585+03:00</announcementDate>
                <directionResponse>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </directionResponse>
        </body>
</contractGateSaveServiceResponse>
Sample Json Request
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "gateId": 0,
    "startDate": "2017-11-30T07:43:47.160+03:00",
    "endDate": "2017-11-30T07:43:47.160+03:00"
  }
}
Sample Json Response
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "contractGateId": 0,
    "gateTypeResponse": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    },
    "startDate": "2017-11-30T07:43:47.177+03:00",
    "endDate": "2017-11-30T07:43:47.177+03:00",
    "gateStatusResponse": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    },
    "contractName": "string",
    "quantity": 0,
    "announcementDate": "2017-11-30T07:43:47.177+03:00",
    "directionResponse": {
      "name": "string",
      "localization": {
        "language": "string",
        "text": "string"
      }
    }
  }
}

5. Kontrat Durum Servisleri

5.1. Kontrat Durumları Listeleme Servisi Kullanımı

Kontratlar için mevcut durumları listelemek için detayları burada olan servis kullanılır.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<contractStatusListServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
        </body>
</contractStatusListServiceRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {}
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<contractStatusListServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <body>
                <contractStatuses>
                        <name>string</name>
                        <localization>
                                <language>string</language>
                                <text>string</text>
                        </localization>
                </contractStatuses>
        </body>
</contractStatusListServiceResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR",
  "body": {
    "contractStatuses": [
      {
        "name": "string",
        "localization": {
          "language": "string",
          "text": "string"
        }
      }
    ]
  }
}

6. Paths

6.1. Aktif Kontrat Derinliği

POST /activecontracts/depth

6.1.1. Description

Aktif Kontrat Derinliği

6.1.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

contractDepthServiceRequest

6.1.3. Responses

HTTP Code Description Schema

200

successful operation

ContractDepthServiceResponse

6.1.4. Consumes

  • application/json

  • application/xml

6.1.5. Produces

  • application/json

  • application/xml

6.1.6. Tags

  • contract

  • trade-engine

6.2. Aktif Kontrat Özet Derinliği

POST /activecontracts/depth-summary

6.2.1. Description

Contract Bid Depth Service

6.2.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

contractDepthServiceRequest

6.2.3. Responses

HTTP Code Description Schema

200

successful operation

ContractDepthSummaryServiceResponse

6.2.4. Consumes

  • application/json

  • application/xml

6.2.5. Produces

  • application/json

  • application/xml

6.2.6. Tags

  • contract

  • trade-engine

6.3. Active Contract Matching Service

POST /activecontracts/matchings

6.3.1. Description

Active Contract Matching Service

6.3.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

activeContractMatchingRequest

6.3.3. Responses

HTTP Code Description Schema

200

successful operation

activeContractMatchingResponse

6.3.4. Consumes

  • application/json

  • application/xml

6.3.5. Produces

  • application/json

  • application/xml

6.3.6. Tags

  • contract

  • trade-engine

6.4. Current Active Regional Contract List Service

POST /activecontracts/regional

6.4.1. Description

Lists active contracts currently is open or is about to open.

6.4.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

contractRequest

6.4.3. Responses

HTTP Code Description Schema

200

successful operation

regionalContractResponse

6.4.4. Consumes

  • application/json

  • application/xml

6.4.5. Produces

  • application/json

  • application/xml

6.4.6. Tags

  • contract

  • trade-engine

6.5. Current Active Contract List Service

POST /activecontracts/standart

6.5.1. Description

Lists active contracts currently is open or is about to open.

6.5.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

contractRequest

6.5.3. Responses

HTTP Code Description Schema

200

successful operation

contractResponse

6.5.4. Consumes

  • application/json

  • application/xml

6.5.5. Produces

  • application/json

  • application/xml

6.5.6. Tags

  • contract

  • trade-engine

6.6. Current Active Weekly Contract List Service

POST /activecontracts/weekly

6.6.1. Description

Lists active weekly contracts currently is open or is about to open.

6.6.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

contractRequest

6.6.3. Responses

HTTP Code Description Schema

200

successful operation

contractResponse

6.6.4. Consumes

  • application/json

  • application/xml

6.6.5. Produces

  • application/json

  • application/xml

6.6.6. Tags

  • contract

  • trade-engine

6.7. Teklif İptali

POST /bid/cancel

6.7.1. Description

Teklif iptal eder.

6.7.2. Parameters

Type Name Description Schema Default

Body

body
optional

bidCancelServiceRequest

6.7.3. Responses

HTTP Code Description Schema

200

successful operation

bidCancelServiceResponse

6.7.4. Consumes

  • application/json

  • application/xml

6.7.5. Produces

  • application/json

  • application/xml

6.7.6. Tags

  • bid

  • trading

6.8. Teklif Kaydetme

POST /bid/save

6.8.1. Description

Teklif kaydeder.

6.8.2. Parameters

Type Name Description Schema Default

Body

body
optional

bidSaveServiceRequest

6.8.3. Responses

HTTP Code Description Schema

200

successful operation

bidSaveServiceResponse

6.8.4. Consumes

  • application/json

  • application/xml

6.8.5. Produces

  • application/json

  • application/xml

6.8.6. Tags

  • bid

  • trading

6.9. Teklif Güncelleme

POST /bid/update

6.9.1. Description

Teklif Günceller.

6.9.2. Parameters

Type Name Description Schema Default

Body

body
optional

bidUpdateServiceRequest

6.9.3. Responses

HTTP Code Description Schema

200

successful operation

bidUpdateServiceResponse

6.9.4. Consumes

  • application/json

  • application/xml

6.9.5. Produces

  • application/json

  • application/xml

6.9.6. Tags

  • bid

  • trading

6.10. Get Contract Configuration

POST /contract-conf/get

6.10.1. Description

Get Contract Configuration By Contract Id

6.10.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

contractConfigurationGetServiceRequest

6.10.3. Responses

HTTP Code Description Schema

200

successful operation

contractConfigurationGetServiceResponse

6.10.4. Consumes

  • application/json

  • application/xml

6.10.5. Produces

  • application/json

  • application/xml

6.10.6. Tags

  • contract-conf

  • trade-engine

6.11. Contract Configuration Save

POST /contract-conf/save

6.11.1. Description

Contract Configuration Save Service

6.11.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

contractConfigurationSaveServiceRequest

6.11.3. Responses

HTTP Code Description Schema

200

successful operation

contractConfigurationSaveServiceResponse

6.11.4. Consumes

  • application/json

  • application/xml

6.11.5. Produces

  • application/json

  • application/xml

6.11.6. Tags

  • contract-conf

  • trade-engine

6.12. Contract Gate Status Update Service

POST /contract-gate/change-status

6.12.1. Description

Contract Gate Status Update Service

6.12.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractGateChangeStatusServiceRequest

6.12.3. Responses

HTTP Code Description Schema

200

successful operation

contractGateSaveServiceResponse

6.12.4. Consumes

  • application/json

  • application/xml

6.12.5. Produces

  • application/json

  • application/xml

6.12.6. Tags

  • contract-gate

6.13. Contract Gate Date Update Service

POST /contract-gate/update

6.13.1. Description

Contract Gate Date Update Service

6.13.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractGateUpdateServiceRequest

6.13.3. Responses

HTTP Code Description Schema

200

successful operation

contractGateSaveServiceResponse

6.13.4. Consumes

  • application/json

  • application/xml

6.13.5. Produces

  • application/json

  • application/xml

6.13.6. Tags

  • contract-gate

6.14. Contract Status List Name

POST /contract-status/list

6.14.1. Description

Contract Status List Description

6.14.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractStatusListServiceRequest

6.14.3. Responses

HTTP Code Description Schema

200

successful operation

contractStatusListServiceResponse

6.14.4. Consumes

  • application/json

  • application/xml

6.14.5. Produces

  • application/json

  • application/xml

6.14.6. Tags

  • contract-status

6.15. Contract Query

POST /contract/get

6.15.1. Description

Contract Query with Contract Name

6.15.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractGetServiceRequest

6.15.3. Responses

HTTP Code Description Schema

200

successful operation

contractGetServiceResponse

6.15.4. Consumes

  • application/json

  • application/xml

6.15.5. Produces

  • application/json

  • application/xml

6.15.6. Tags

  • contract

  • trade-engine

6.16. Contract Save

POST /contract/save

6.16.1. Description

Contract Save

6.16.2. Parameters

Type Name Description Schema Default

Body

body
optional

contractSaveServiceRequest

6.16.3. Responses

HTTP Code Description Schema

200

successful operation

contractSaveServiceResponse

6.16.4. Consumes

  • application/json

  • application/xml

6.16.5. Produces

  • application/json

  • application/xml

6.16.6. Tags

  • contract

  • trade-engine

6.17. GRP Calculation

POST /market-price/calculate-grp

6.17.1. Description

GRP Calculation

6.17.2. Parameters

Type Name Description Schema Default

Body

body
optional

grpPriceGetRequest

6.17.3. Responses

HTTP Code Description Schema

200

successful operation

grpPriceServiceResponse

6.17.4. Consumes

  • application/json

  • application/xml

6.17.5. Produces

  • application/json

  • application/xml

6.17.6. Tags

  • market-price

6.18. Match Change Status

POST /match/change-status

6.18.1. Description

Changes the status of the match.

6.18.2. Parameters

Type Name Description Schema Default

Body

body
optional

matchChangeStatusServiceRequest

6.18.3. Responses

HTTP Code Description Schema

200

successful operation

matchChangeStatusServiceResponse

6.18.4. Consumes

  • application/json

  • application/xml

6.18.5. Produces

  • application/json

  • application/xml

6.18.6. Tags

  • match

6.19. Ödeme Talebi

POST /payment/order

6.19.1. Description

Ödeme Taleplerini Değerlendiren Servistir

6.19.2. Parameters

Type Name Description Schema Default

Header

stp-service-ticket
required

STP Service ST Header

string

Body

body
optional

paymentOrderServiceRequest

6.19.3. Responses

HTTP Code Description Schema

200

successful operation

PaymentServiceResponse

6.19.4. Consumes

  • application/json

  • application/xml

6.19.5. Produces

  • application/json

  • application/xml

6.19.6. Tags

  • payment

7. Definitions

7.1. ActiveContractMatchingRequestBody

Active Contract Matching List Request

Name Description Schema

contractNames
required

Contracts

< string > array

7.2. ActiveContractMatchingResponseBody

Active Contract Matching Response

Name Description Schema

matchings
optional

< Match > array

7.3. AmountPrice

Amount and Price

Name Description Schema

amount
optional

Amount

integer(int64)

owner
optional

Owner
Default : false

boolean

price
optional

Price

number

7.4. BidCancelRequestBody

Teklif İptal Servis İstek Yapısı

Name Description Schema

bidId
required

Teklif Tekil Numarası

string

7.5. BidCancelResponseBody

Teklif İptal Servis Cevap Yapısı

Name Description Schema

bidResponse
optional

Teklif Oluşturma/Güncelleme Servis Cevap Yapısı

BidResponse

7.6. BidMatchStatusResponse

Eşleşme Durumları Servis Cevap Yapısı

Name Description Schema

localization
required

= {BID_MATCH_STATUS_LOCALIZATION}

LocalizationResponse

name
required

= {BID_MATCH_STATUS_NAME}

string

7.7. BidResponse

Teklif Oluşturma/Güncelleme Servis Cevap Yapısı

Name Description Schema

id
optional

Teklif Tekil Numarası

string

7.8. BidSaveRequestBody

Teklif Oluşturma Servis İstek Yapısı

Name Description Schema

bidProcessName
optional

Bid Process Name

string

bidStatus
required

Teklif Durumları
Example : "ACTIVE, PASSIVE, CANCEL, ACCEPTED, PROCESSING"

string

bidType
required

Teklif Tipleri
Example : "MATCH_AND_DESTROY_REST, STANDART_MATCH, MATCH_WITH_TIME_LIMIT"

string

contractName
required

Contract Name
Example : "GG20180901"

string

direction
required

Direction Name
Example : "BUY,SELL"

string

expireTime
optional

= {REMAINING_TIME}
Example : "2017-02-07T09:31:33.000+03:00"

string(date-time)

pointName
optional

Teklif Noktası

string

price
optional

Fiyat
Example : 100.25

number

quantity
required

Miktar
Example : 155

integer(int64)

7.9. BidSaveResponseBody

Teklif Oluşturma SErvis Cevap Yapısı

Name Description Schema

bidResponse
optional

Teklif Oluşturma/Güncelleme Servis Cevap Yapısı

BidResponse

7.10. BidStatusResponse

Teklif Durum Listesi Servis Cevabı

Name Description Schema

localization
required

Teklif Durumları Yerelleştime

LocalizationResponse

name
required

Teklif Durumları

string

7.11. BidTypeResponse

Teklif Tip Listesi Servis Cevabı

Name Description Schema

localization
required

Teklif Tipleri Yerelleştime

LocalizationResponse

name
required

Teklif Tipleri

string

7.12. BidUpdateReasonResponse

Telif Güncelleme Sebep Listesi Servis Cevabı

Name Description Schema

localization
required

= {BID_UPDATE_REASON_LOCALIZATION}

LocalizationResponse

name
required

= {BID_UPDATE_REASON_NAME}

string

7.13. BidUpdateRequestBody

Teklif Güncelleme Servis İstek Yapısı

Name Description Schema

bidId
required

Teklif Tekil Numarası

string

bidStatus
required

Teklif Durumları

string

price
optional

Fiyat

number

quantity
required

Miktar

integer(int64)

7.14. BidUpdateResponseBody

Teklif Güncelleme Servis Cevap Yapısı

Name Description Schema

bidResponse
optional

Teklif Oluşturma/Güncelleme Servis Cevap Yapısı

BidResponse

7.15. ContractConfigurationGetRequestBody

Contract Configuration Get Service Request

Name Description Schema

contractName
required

Contract Name

string

7.16. ContractConfigurationGetResponseBody

Contract Configuration Get Service Response

Name Description Schema

baseCoefficient
optional

Base Product Coefficient

number

ceilingCoefficient
optional

Ceiling Product Coefficient

number

contractConfId
optional

Contract Configuration Id

integer(int64)

dapFinalDate
optional

Day Ahead Price Finalization Date

string(date-time)

dapScopeDate
optional

Day Ahead Price Scope Date

string(date-time)

gateList
optional

Contract Configuration Gate Operations

< ContractGateResponse > array

grpFinalDate
optional

Gas Reference Price Finalization Date

string(date-time)

grpScopeDate
optional

Gas Reference Price Scope Date

string(date-time)

lpa
optional

Last Price Average

integer(int64)

lqa
optional

Last Quantitiy Average

integer(int64)

marketBasePrice
optional

Market Base Price

number

marketCeilingPrice
optional

Market Ceiling Price

number

marketMaxQuantity
optional

Market Max Quantity

integer(int64)

marketMinQuantity
optional

Market Min Quantity

integer(int64)

nbpOpenTime
optional

National Balancing Point Open Time

number

objectionTime
optional

Objection Time

number

retrospectiveAverage
optional

Gas Reference Price Retrospective Average

number

transmissionBasePrice
optional

Transmission Base Price

number

transmissionBasePriceFormula
optional

Transmission Base Price Formula

string

transmissionCeilingPrice
optional

Transmission Ceiling Price

number

transmissionCeilingPriceFormula
optional

Transmission Ceiling Price Formula

string

transmissionMaxQuantity
optional

Transmission Max Quantity

integer(int64)

transmissionMinQuantity
optional

Transmission Min Quantity

integer(int64)

7.17. ContractConfigurationSaveRequestBody

Contract Configuration Save Service Request

Name Description Schema

average
optional

Gas Reference Price Retrospective Average

number

baseCoefficient
optional

Base Product Coefficient

number

ceilingCoefficient
optional

Ceiling Product Coefficient

number

contractName
required

Contract Name

string

dapFinalDate
required

Day Ahead Price Finalization Date

string(date-time)

dapScopeDate
required

Day Ahead Price Scope Date

string(date-time)

grpFinalDate
required

Gas Reference Price Finalization Date

string(date-time)

grpScopeDate
required

Gas Reference Price Scope Date

string(date-time)

lpa
optional

Last Price Average

integer(int64)

lqa
optional

Last Quantitiy Average

integer(int64)

marketBasePrice
optional

Market Base Price

number

marketCeilingPrice
optional

Market Ceiling Price

number

marketMaxQuantity
optional

Market Max Quantity

integer(int64)

marketMinQuantity
optional

Market Min Quantity

integer(int64)

modifyUser
optional

Modify User

string

nbpOpenTime
optional

National Balancing Point Open Time

number

objectionTime
optional

Objection Time

number

transmissionBasePrice
optional

Transmission Base Price

number

transmissionBasePriceFormula
optional

Transmission Base Price Formula

string

transmissionCeilingPrice
optional

Transmission Ceiling Price

number

transmissionCeilingPriceFormula
optional

Transmission Ceiling Price Formula

string

transmissionMaxQuantity
optional

Transmission Max Quantity

integer(int64)

transmissionMinQuantity
optional

Transmission Min Quantity

integer(int64)

7.18. ContractConfigurationSaveResponseBody

Contract Configuration Save Service Response

Type : object

7.19. ContractDepthRequestBody

Kontrat Derinliği Servis İstek Yapısı

Name Description Schema

contractName
required

Contract Name

string

7.20. ContractDepthResponseBody

Kontrat Derinliği Servis Cevap Yapısı

Name Description Schema

contractBuyDepths
optional

< AmountPrice > array

contractSellDepths
optional

< AmountPrice > array

7.21. ContractDepthServiceResponse

Kontrat Derinliği Servis Cevap

Name Description Schema

body
optional

ContractDepthResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.22. ContractDepthSummaryResponse

Contract Bid Depth Service Response

Name Description Schema

bidState
optional

Bid State

StringType

bidStatus
optional

Teklif Durumu

BidStatusResponse

createDate
optional

Teklif Oluşturma Tarihi

string(date-time)

direction
optional

Teklif Yönü

DirectionResponse

lastMatchingsPriceAverage
optional

Last Matching Price Average

number

lastMatchingsQuantityAverage
optional

Last Matching Quantity Average

integer(int64)

organization
optional

Organizasyon

StringType

organizationId
optional

Organizasyon Tekil Numarası

integer(int64)

price
optional

Teklif Fiyatı

number

quantity
optional

Teklif Miktarı

integer(int64)

remaingQuatity
optional

= {BID_REMAINING_QUANTITY}

integer(int64)

7.23. ContractDepthSummaryResponseBody

Contract Bid Depth Service Response Body

Name Description Schema

contractDepthSummaryResponses
optional

< ContractDepthSummaryResponse > array

7.24. ContractDepthSummaryServiceResponse

Contract Bid Depth Service Response

Name Description Schema

body
optional

ContractDepthSummaryResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.25. ContractGateChangeStatusRequestBody

Contract Gate Status Update Request Body

Name Description Schema

gateId
required

Contract Configuration Gate Id

integer(int64)

gateStatusName
required

Kontrat Kapı Durumu

string

7.26. ContractGateResponse

Contract Configuration Get Service Response

Name Description Schema

announcementDate
optional

Kontrat Kapı Duyuru Zamanı

string(date-time)

contractGateId
optional

Contract Configuration Gate Id

integer(int64)

contractName
optional

Contract Name

string

directionResponse
optional

Direction Name

DirectionResponse

endDate
optional

Contract Configuration Gate End Date

string(date-time)

gateStatusResponse
optional

Contract Gate Status

ContractGateStatusResponse

gateTypeResponse
optional

Contract Configuration Gate Name

ContractGateTypeResponse

quantity
optional

Kontrat Kapı Miktarı

integer(int64)

startDate
optional

Contract Configuration Gate Start Date

string(date-time)

7.27. ContractGateStatusResponse

Kontrat Kapı Durumu Servis Cevabı

Name Description Schema

localization
required

Kontrat Kapı Durumu Yerelleştirme

LocalizationResponse

name
required

Kontrat Kapı Durumu

string

7.28. ContractGateTypeResponse

Kontrat Kapı Tipi

Name Description Schema

localization
required

Kontrat Kapı Tipi Yerelleştirme

LocalizationResponse

name
required

Contract Configuration Gate Name

string

7.29. ContractGateUpdateRequestBody

Contract Gate Date Update Service Request

Name Description Schema

endDate
optional

Contract Configuration Gate End Date

string(date-time)

gateId
optional

Contract Configuration Gate Id

integer(int64)

startDate
optional

Contract Configuration Gate Start Date

string(date-time)

7.30. ContractGetRequestBody

Contract Get Service Request

Name Description Schema

contractName
required

Contract Name

string

7.31. ContractResponseBody

Current Active Contract List Service Response

Name Description Schema

contracts
optional

< ContractSummary > array

7.32. ContractSaveRequestBody

Contract Get Service Request

Name Description Schema

contractTypeName
required

Contract Type Name

string

directionName
required

Contract Direction

string

gasDayDate
optional

string(date-time)

gasDayDates
required

Gas Day Dates

< string(date-time) > array

physicalPointIds
required

Contract Physical Points

< integer(int64) > array

quantity
required

Contract Quantity

integer(int64)

7.33. ContractServiceResponseBody

Contract Get Service Response

Name Description Schema

activationDate
required

Contract Activation Date

string(date-time)

closeDate
required

Contract Close Date

string(date-time)

contractName
required

Contract Name

string

contractStatus
required

Contract Status

ContractStatusResponse

contractType
required

Contract Type

ContractTypeResponse

createDate
required

Contract Create Date

string(date-time)

direction
required

Contract Direction

DirectionResponse

gasDays
required

Contract Gas Days

< GasDayResponse > array

physicalPointIds
required

Contract Physical Points

< integer(int64) > array

quantity
required

Contract Quantity

integer(int64)

7.34. ContractStatusListRequestBody

Contract Status List Service Request

Type : object

7.35. ContractStatusListResponse

Contract Status List Service Response

Name Description Schema

contractStatuses
optional

< ContractStatusResponse > array

7.36. ContractStatusResponse

Contract Status List Service Response

Name Description Schema

localization
required

Contract Status Localization

LocalizationResponse

name
required

Contract Status Name

string

7.37. ContractSummary

Kontrat Özeti

Name Description Schema

activationTime
required

Contract Activation Date

string(date-time)

bestAmountPriceBuying
required

Best Buying

AmountPrice

bestAmountPriceSelling
required

Best Selling

AmountPrice

closingTime
required

Contract Closing Time

string(date-time)

deliveryDays
required

Gas Delivery Days

< string(date-time) > array

gasDays
required

Contract Gas Days

< GasDay > array

highestMatchingPrice
required

Highest Matching Price

number

lastMatchingPrice
required

Last Matching Price

number

lastMatchingPriceDirection
required

Contract Price Matching Direction

enum (UP, DOWN, IDLE)

name
required

Contract Name

string

status
required

Contract State

StringType

type
required

Type

StringType

weightedAverage
required

Weighted Average

number

weightedAverageDirection
required

Contract Price Matching Direction

enum (UP, DOWN, IDLE)

7.38. ContractTypeResponse

Contract Type List Service Response

Name Description Schema

localization
required

Contract Type Localization

LocalizationResponse

name
required

Contract Type Name

string

7.39. DirectionResponse

Direction List Service Response

Name Description Schema

localization
required

Direciton Localization

LocalizationResponse

name
required

Direction Name

string

7.40. EmptyRequestBody

Type : object

7.41. GasDay

Contract Gas Day

Name Description Schema

advancePaymentDate
optional

Advance Payment Date

string(date-time)

gasDayDate
optional

Gas Day Date

string(date-time)

gasDayId
optional

Gas Day ID

integer(int64)

gasDeliveryEndDate
optional

Gas Day End Date

string(date-time)

gasDeliveryStartDate
optional

Gas Day Start Date

string(date-time)

registrationPeriodId
optional

Gas Day Registration Period ID

integer(int64)

7.42. GasDayResponse

Gas Day List Service Response

Name Description Schema

advancePaymentDate
required

Advance Payment Date

string(date-time)

gasDayDate
required

Gas Day Date

string(date-time)

gasDayId
required

Gas Day ID

integer(int64)

gasDeliveryEndDate
required

Gas Day End Date

string(date-time)

gasDeliveryStartDate
required

Gas Day Start Date

string(date-time)

registrationPeriodId
required

Gas Day Registration Period ID

integer(int64)

7.43. GrpPriceGetRequestBody

GRP Calculate Service Request

Name Description Schema

contractType
required

Contract Type

string

gasDay
required

Gas Day Date

string(date-time)

7.44. GrpPriceResponseBody

GRP Calculate Service Response

Name Description Schema

basePrice
optional

number

ceilingPrice
optional

number

7.45. Header

Header information.

Name Description Schema

key
optional

Header key.
Example : "transactionId"

string

value
optional

Header value.
Example : "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"

string

7.46. LocalizationResponse

Localization Service Response

Name Description Schema

language
required

Localization Language

string

text
required

Localization Text

string

7.47. Match

Matching

Name Description Schema

contract
required

Contract Name

string

matchId
required

Matching Id

string

matchStatus
required

Eşleşme Durumu

string

matchingTime
required

Matching Time

string(date-time)

myOwnMatching
required

My Own Matching
Default : false

boolean

pointName
optional

Teklif Noktası

string

price
required

Fiyat

number

quantity
required

Miktar

integer(int64)

7.48. MatchChangeStatusRequestBody

Eşleşme Durum Değiştire Servis İstek Yapısı

Name Description Schema

description
required

Changes the status of the match.

string

matchId
required

Eşleşme Tekil Numarası

string

statusName
required

Eşleşme Durumu

string

7.49. MatchChangeStatusRequestListBody

Eşleşme Durum Değiştire Servis İstek Yapısı

Name Description Schema

matchList
optional

< MatchChangeStatusRequestBody > array

7.50. MatchListResponse

Eşleşme Listesi Servis Cevabı

Name Description Schema

matchList
optional

< MatchResponse > array

7.51. MatchReasonResponse

EŞleşme Neden Listesi Servis Cevabı

Name Description Schema

localization
required

Eşleşme Nedeni Yerelleştirme

LocalizationResponse

name
required

Eşleşme Nedeni

string

7.52. MatchResponse

Eşleşme Listesi Servis Cevabı

Name Description Schema

contractName
required

Contract Name

string

createDate
required

Eşleşme Oluşma Tarihi

string(date-time)

createUser
required

Eşleşme Oluşturan Kullanıcı(jxc)

string

matchId
required

Eşleşme Tekil Numarası

string

matchStatus
required

= {MATCH_STATUS}

MatchStatusResponse

price
required

Eşleşme Fiyatı

number

purchaseBid
required

Eşleşme Alış Teklifi

BidResponse

purchaseMatchReason
required

Alış Teklifi Eşleşme Nedeni

MatchReasonResponse

quantity
required

Eşleşme Miktarı

integer(int64)

saleBid
required

Eşleşme Satış Teklifi

BidResponse

saleMatchReason
required

Satış Teklifi Eşleşme Nedeni

MatchReasonResponse

7.53. MatchStatusResponse

Eşleşme Durumu Servis Cevabı

Name Description Schema

localization
required

Eşleşme Durumu Yerelleştirme

LocalizationResponse

name
required

Eşleşme Durumu

string

7.54. PaymentOrder

Payment Order

Name Description Schema

amount
required

Payment Amount

number

eic
required

EIC

string

paymentOrderId
required

Order Id

integer(int64)

requestTime
required

Withdrawal Request Time
Example : "2017-02-07T09:31:33.000+03:00"

string(date-time)

7.55. PaymentOrderRequestBody

Ödeme Talebi İsteği

Name Description Schema

orders
optional

< PaymentOrder > array

7.56. PaymentOrderResult

Payment Request Result

Name Description Schema

amount
required

Payment Amount

number

eic
required

EIC

string

paymentOrderId
required

Order Id

integer(int64)

status
required

Order Status

StringType

7.57. PaymentResponseBody

Ödeme Talebi Cevabı

Name Description Schema

results
optional

< PaymentOrderResult > array

7.58. PaymentServiceResponse

Ödeme Talebi Cevabı

Name Description Schema

body
optional

PaymentResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.59. RegionalContractResponseBody

Bölgesel Aktif Kontractlar Servis Cevabı

Name Description Schema

contracts
optional

< RegionalContractSummary > array

7.60. RegionalContractSummary

Regional Contracts

Name Description Schema

activationTime
required

Contract Activation Date

string(date-time)

bestAmountPriceBuying
required

Best Buying

AmountPrice

bestAmountPriceSelling
required

Best Selling

AmountPrice

closingTime
required

Contract Closing Time

string(date-time)

deliveryDays
required

Gas Delivery Days

< string(date-time) > array

direction
optional

Direction

string

gasDays
required

Contract Gas Days

< GasDay > array

locations
required

Locations

< string > array

name
required

Contract Name

string

remainingAmount
required

Remaining Amount

integer(int64)

status
required

Contract State

StringType

totalAmount
required

Total Amount

integer(int64)

type
required

Type

StringType

7.61. StringType

String Tipi

Name Description Schema

text
required

Metin

string

value
required

Değer

string

7.62. activeContractMatchingRequest

Active Contract Matching List Request

Name Description Schema

body
optional

ActiveContractMatchingRequestBody

headers
optional

Header information.

< Header > array

7.63. activeContractMatchingResponse

Active Contract Matching Response

Name Description Schema

body
optional

ActiveContractMatchingResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.64. bidCancelServiceRequest

Teklif İptal Servis İsteği

Name Description Schema

body
optional

BidCancelRequestBody

headers
optional

Header information.

< Header > array

7.65. bidCancelServiceResponse

Teklif İptal Servis Cevabı

Name Description Schema

body
optional

BidCancelResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.66. bidSaveServiceRequest

Teklif Kaydetme Servis İsteği

Name Description Schema

body
optional

BidSaveRequestBody

headers
optional

Header information.

< Header > array

7.67. bidSaveServiceResponse

Teklif Kaydetme Servis Cevabı

Name Description Schema

body
optional

BidSaveResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.68. bidUpdateServiceRequest

Teklif Güncelleme Servis İsteği

Name Description Schema

body
optional

BidUpdateRequestBody

headers
optional

Header information.

< Header > array

7.69. bidUpdateServiceResponse

Teklif Güncelleme Servis Cevabı

Name Description Schema

body
optional

BidUpdateResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.70. contractConfigurationGetServiceRequest

Contract Configuration Get Service Request

Name Description Schema

body
optional

ContractConfigurationGetRequestBody

headers
optional

Header information.

< Header > array

7.71. contractConfigurationGetServiceResponse

Contract Configuration Get Service Response

Name Description Schema

body
optional

ContractConfigurationGetResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.72. contractConfigurationSaveServiceRequest

Contract Configuration Save Service Request

Name Description Schema

body
optional

ContractConfigurationSaveRequestBody

headers
optional

Header information.

< Header > array

7.73. contractConfigurationSaveServiceResponse

Contract Configuration Save Service Response

Name Description Schema

body
optional

ContractConfigurationSaveResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.74. contractDepthServiceRequest

Kontrat Derinliği Servis Cevabı

Name Description Schema

body
required

ContractDepthRequestBody

headers
optional

Header information.

< Header > array

7.75. contractGateChangeStatusServiceRequest

Contract Gate Status Update Service Request

Name Description Schema

body
optional

ContractGateChangeStatusRequestBody

headers
optional

Header information.

< Header > array

7.76. contractGateSaveServiceResponse

Kontrat Kapı Kaydetme Servis Cevabı

Name Description Schema

body
optional

ContractGateResponse

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.77. contractGateUpdateServiceRequest

Contract Gate Date Update Service Request

Name Description Schema

body
optional

ContractGateUpdateRequestBody

headers
optional

Header information.

< Header > array

7.78. contractGetServiceRequest

Contract Get Service Request

Name Description Schema

body
optional

ContractGetRequestBody

headers
optional

Header information.

< Header > array

7.79. contractGetServiceResponse

Contract Get Service Response

Name Description Schema

body
optional

ContractServiceResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.80. contractRequest

Contract List Request

Name Description Schema

body
optional

EmptyRequestBody

headers
optional

Header information.

< Header > array

7.81. contractResponse

Current Active Contract List Service Response

Name Description Schema

body
optional

ContractResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.82. contractSaveServiceRequest

Contract Get Service Request

Name Description Schema

body
optional

ContractSaveRequestBody

headers
optional

Header information.

< Header > array

7.83. contractSaveServiceResponse

Contract Get Service Response

Name Description Schema

body
optional

ContractServiceResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.84. contractStatusListServiceRequest

Contract Status List Service Request

Name Description Schema

body
optional

ContractStatusListRequestBody

headers
optional

Header information.

< Header > array

7.85. contractStatusListServiceResponse

Contract Status List Service Response

Name Description Schema

body
optional

ContractStatusListResponse

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.86. grpPriceGetRequest

GRP Calculate Service Request

Name Description Schema

body
required

GrpPriceGetRequestBody

headers
optional

Header information.

< Header > array

7.87. grpPriceServiceResponse

GRP Calculate Service Response

Name Description Schema

body
optional

GrpPriceResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.88. matchChangeStatusServiceRequest

Match Change Status Service Request

Name Description Schema

body
optional

MatchChangeStatusRequestListBody

headers
optional

Header information.

< Header > array

7.89. matchChangeStatusServiceResponse

Match Change Status Service Response

Name Description Schema

body
optional

MatchListResponse

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

7.90. paymentOrderServiceRequest

Ödeme Talebi İsteği

Name Description Schema

body
optional

PaymentOrderRequestBody

headers
optional

Header information.

< Header > array

7.91. regionalContractResponse

Bölgesel Aktif Kontractlar Servis Cevabı

Name Description Schema

body
optional

RegionalContractResponseBody

resultCode
required

0 for successful requests. For unsuccessful requests, this value contains the error code.
Example : "0"

string

resultDescription
required

Returns OK if successful or error description otherwise.
Example : "OK"

string

resultType
required

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR"

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
optional

SUCCESS for successful requests BUSINESSERROR if a business is blocked by the rule. SECURITYERROR if it is attached to security or authorization control, SYSTEMERROR if there is a system error.
Example : "Transaction Id"

string

Unresolved directive in index.adoc - include::operationCodeGetService.adoc[] Unresolved directive in index.adoc - include::operationHistoryGetService.adoc[]