Genel Bakış

Versiyon bilgisi

Versiyon : v1

URI şeması

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

Etiketler

  • 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. Kontrat Kapı Servisleri

4.1. Kontrat Kapı Durum Değiştirme Servisi Nasıl Çağırılır?

Servis detaylarına buradan ulaşabilirsiniz.

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. Kontrat Kapı Güncelleme Servisi Nasıl Çağırılır?

Servis detaylarına buradan ulaşabilirsiniz.

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. Ödeme Servisleri

6.1. Ödeme Servisleri Kullanımı

Ödeme onayı alınması için kullanılır. Buradan olan servis parametrelerine erişilebilir.

Örnek XML İstek
<?xml version="1.0" encoding="UTF-8"?>
<paymentOrderServiceRequest>
        <headers>
                <key>transactionId</key>
                <value>6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac</value>
        </headers>
        <body>
                <orders>
                        <eic>40XABCDEFG</eic>
                        <paymentOrderId>1500356</paymentOrderId>
                        <amount>6589.98</amount>
                </orders>
                <orders>
                        <eic>40XABCDEFG</eic>
                        <paymentOrderId>1500356</paymentOrderId>
                        <amount>6589.98</amount>
                </orders>
                <orders>
                        <eic>40XABCDEFG</eic>
                        <paymentOrderId>1500356</paymentOrderId>
                        <amount>6589.98</amount>
                </orders>
        </body>
</paymentOrderServiceRequest>
Örnek Json İstek
{
  "headers": [
    {
      "key": "transactionId",
      "value": "6d553b3c-1ffc-44cc-bed6-1dce4d5b48ac"
    }
  ],
  "body": {
    "orders": [
      {
        "eic": "40XABCDEFG",
        "paymentOrderId": 150098,
        "amount": 1502.98
      },
      {
        "eic": "40XABCDEFG",
        "paymentOrderId": 150098,
        "amount": 1502.98
      },
      {
        "eic": "40XABCDEFG",
        "paymentOrderId": 150098,
        "amount": 1502.98
      }
    ]
  }
}
Örnek XML Cevap
<?xml version="1.0" encoding="UTF-8"?>
<paymentServiceResponse>
        <resultCode>0</resultCode>
        <resultDescription>OK</resultDescription>
        <resultType>SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR</resultType>
        <transactionId>Transaction Id</transactionId>
        <body>
                <results>
                        <eic>40XABCDEFG</eic>
                        <paymentOrderId>150098</paymentOrderId>
                        <status>
                                <value>Y</value>
                                <text>Evet</text>
                        </status>
                </results>
                <results>
                        <eic>40XABCDEFG</eic>
                        <paymentOrderId>150099</paymentOrderId>
                        <status>
                                <value>N</value>
                                <text>Hayır</text>
                        </status>
                </results>
        </body>
</paymentServiceResponse>
Örnek Json Cevap
{
  "resultCode": "0",
  "resultDescription": "OK",
  "resultType": "SUCCESS",
  "transactionId": "Transaction Id",
  "body": {
    "results": [
      {
        "eic": "40XABCDEFG",
        "paymentOrderId": 150098,
        "status": {
          "value": "Y",
          "text": "Evet"
        }
      },
      {
        "eic": "40XABCDEFG",
        "paymentOrderId": 150099,
        "status": {
          "value": "N",
          "text": "Hayır"
        }
      },
      {
        "eic": "40XABCDEFG",
        "paymentOrderId": 150097,
        "status": {
          "value": "N",
          "text": "Hayır"
        }
      }
    ]
  }
}

7. Dizinler

7.1. Aktif Kontrat Derinliği

POST /activecontracts/depth

7.1.1. Açıklama

Aktif Kontrat Derinliği

7.1.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

contractDepthServiceRequest

7.1.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

ContractDepthServiceResponse

7.1.4. Kullanılanlar

  • application/json

  • application/xml

7.1.5. Üretilenler

  • application/json

  • application/xml

7.1.6. Etiketler

  • contract

  • trade-engine

7.2. Aktif Kontrat Özet Derinliği

POST /activecontracts/depth-summary

7.2.1. Açıklama

Kontratlara Ait Teklif Derinliği Servisi

7.2.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

contractDepthServiceRequest

7.2.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

ContractDepthSummaryServiceResponse

7.2.4. Kullanılanlar

  • application/json

  • application/xml

7.2.5. Üretilenler

  • application/json

  • application/xml

7.2.6. Etiketler

  • contract

  • trade-engine

7.3. Aktif Kontratlara Ait Eşleşme Servisi

POST /activecontracts/matchings

7.3.1. Açıklama

Aktif Kontratlara Ait Eşleşmeleri Döner

7.3.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

activeContractMatchingRequest

7.3.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

activeContractMatchingResponse

7.3.4. Kullanılanlar

  • application/json

  • application/xml

7.3.5. Üretilenler

  • application/json

  • application/xml

7.3.6. Etiketler

  • contract

  • trade-engine

7.4. Aktif Noktasal Bölgesel Kontratları Listeleme Servisi

POST /activecontracts/regional

7.4.1. Açıklama

Teklif verilebilecek yada yakın zamanda teklif verilmeye açılacak olan noktasal bölgesel kontratları listeler.

7.4.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

contractRequest

7.4.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

regionalContractResponse

7.4.4. Kullanılanlar

  • application/json

  • application/xml

7.4.5. Üretilenler

  • application/json

  • application/xml

7.4.6. Etiketler

  • contract

  • trade-engine

7.5. Aktif Kontratları Listeleme Servisi

POST /activecontracts/standart

7.5.1. Açıklama

Teklif verilebilecek yada yakın zamanda teklif verilmeye açılacak olan kontratları listeler.

7.5.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

contractRequest

7.5.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

contractResponse

7.5.4. Kullanılanlar

  • application/json

  • application/xml

7.5.5. Üretilenler

  • application/json

  • application/xml

7.5.6. Etiketler

  • contract

  • trade-engine

7.6. Aktif Haftalık Kontratları Listeleme Servisi

POST /activecontracts/weekly

7.6.1. Açıklama

Teklif verilebilecek yada yakın zamanda teklif verilmeye açılacak olan haftalık kontratları listeler.

7.6.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

contractRequest

7.6.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

contractResponse

7.6.4. Kullanılanlar

  • application/json

  • application/xml

7.6.5. Üretilenler

  • application/json

  • application/xml

7.6.6. Etiketler

  • contract

  • trade-engine

7.7. Teklif İptali

POST /bid/cancel

7.7.1. Açıklama

Teklif iptal eder.

7.7.2. Parametreler

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

Body

body
opsiyonel

bidCancelServiceRequest

7.7.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

bidCancelServiceResponse

7.7.4. Kullanılanlar

  • application/json

  • application/xml

7.7.5. Üretilenler

  • application/json

  • application/xml

7.7.6. Etiketler

  • bid

  • trading

7.8. Teklif Kaydetme

POST /bid/save

7.8.1. Açıklama

Teklif kaydeder.

7.8.2. Parametreler

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

Body

body
opsiyonel

bidSaveServiceRequest

7.8.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

bidSaveServiceResponse

7.8.4. Kullanılanlar

  • application/json

  • application/xml

7.8.5. Üretilenler

  • application/json

  • application/xml

7.8.6. Etiketler

  • bid

  • trading

7.9. Teklif Güncelleme

POST /bid/update

7.9.1. Açıklama

Teklif Günceller.

7.9.2. Parametreler

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

Body

body
opsiyonel

bidUpdateServiceRequest

7.9.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

bidUpdateServiceResponse

7.9.4. Kullanılanlar

  • application/json

  • application/xml

7.9.5. Üretilenler

  • application/json

  • application/xml

7.9.6. Etiketler

  • bid

  • trading

7.10. Kontrat Konfigurasyonları Sorgulama

POST /contract-conf/get

7.10.1. Açıklama

Kontrat Id ile Kontrat Konfigurasyonları Sorgulama

7.10.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

contractConfigurationGetServiceRequest

7.10.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

contractConfigurationGetServiceResponse

7.10.4. Kullanılanlar

  • application/json

  • application/xml

7.10.5. Üretilenler

  • application/json

  • application/xml

7.10.6. Etiketler

  • contract-conf

  • trade-engine

7.11. Kontrat Konfigürasyon Kaydetme

POST /contract-conf/save

7.11.1. Açıklama

Kontrat Konfigürasyonu Kaydetme Servisi

7.11.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

contractConfigurationSaveServiceRequest

7.11.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

contractConfigurationSaveServiceResponse

7.11.4. Kullanılanlar

  • application/json

  • application/xml

7.11.5. Üretilenler

  • application/json

  • application/xml

7.11.6. Etiketler

  • contract-conf

  • trade-engine

7.12. Kontrat Kapı Statü Güncelleme Servisi

POST /contract-gate/change-status

7.12.1. Açıklama

Kontrat Kapı Statü Güncelleme Servisi

7.12.2. Parametreler

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

Body

body
opsiyonel

contractGateChangeStatusServiceRequest

7.12.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

contractGateSaveServiceResponse

7.12.4. Kullanılanlar

  • application/json

  • application/xml

7.12.5. Üretilenler

  • application/json

  • application/xml

7.12.6. Etiketler

  • contract-gate

7.13. Kontrat Kapı Tarihi Güncelleme Servisi

POST /contract-gate/update

7.13.1. Açıklama

Kontrat Kapı Tarihi Güncelleme Servis İsteği

7.13.2. Parametreler

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

Body

body
opsiyonel

contractGateUpdateServiceRequest

7.13.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

contractGateSaveServiceResponse

7.13.4. Kullanılanlar

  • application/json

  • application/xml

7.13.5. Üretilenler

  • application/json

  • application/xml

7.13.6. Etiketler

  • contract-gate

7.14. Kontrat Durum Listeleme Servis Adı

POST /contract-status/list

7.14.1. Açıklama

Kontrat Durum Listeleme Servis Açıklama

7.14.2. Parametreler

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

Body

body
opsiyonel

contractStatusListServiceRequest

7.14.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

contractStatusListServiceResponse

7.14.4. Kullanılanlar

  • application/json

  • application/xml

7.14.5. Üretilenler

  • application/json

  • application/xml

7.14.6. Etiketler

  • contract-status

7.15. Kontrat Sorgulama

POST /contract/get

7.15.1. Açıklama

Kontrat adi ile kontrat sorgulama

7.15.2. Parametreler

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

Body

body
opsiyonel

contractGetServiceRequest

7.15.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

contractGetServiceResponse

7.15.4. Kullanılanlar

  • application/json

  • application/xml

7.15.5. Üretilenler

  • application/json

  • application/xml

7.15.6. Etiketler

  • contract

  • trade-engine

7.16. Kontrat Kaydet

POST /contract/save

7.16.1. Açıklama

Kontrat Kaydet

7.16.2. Parametreler

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

Body

body
opsiyonel

contractSaveServiceRequest

7.16.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

contractSaveServiceResponse

7.16.4. Kullanılanlar

  • application/json

  • application/xml

7.16.5. Üretilenler

  • application/json

  • application/xml

7.16.6. Etiketler

  • contract

  • trade-engine

7.17. GRP Değerinin Hesaplanması

POST /market-price/calculate-grp

7.17.1. Açıklama

GRP Değerinin Hesaplanması

7.17.2. Parametreler

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

Body

body
opsiyonel

grpPriceGetRequest

7.17.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

grpPriceServiceResponse

7.17.4. Kullanılanlar

  • application/json

  • application/xml

7.17.5. Üretilenler

  • application/json

  • application/xml

7.17.6. Etiketler

  • market-price

7.18. Eşleşme Durum Değiştirme

POST /match/change-status

7.18.1. Açıklama

Eşleşme durumunu değiştirme servisidir.

7.18.2. Parametreler

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

Body

body
opsiyonel

matchChangeStatusServiceRequest

7.18.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

matchChangeStatusServiceResponse

7.18.4. Kullanılanlar

  • application/json

  • application/xml

7.18.5. Üretilenler

  • application/json

  • application/xml

7.18.6. Etiketler

  • match

7.19. Ödeme Talebi

POST /payment/order

7.19.1. Açıklama

Ödeme Taleplerini Değerlendiren Servistir

7.19.2. Parametreler

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

Header

stp-service-ticket
gerekli

STP Servis ST Header

string

Body

body
opsiyonel

paymentOrderServiceRequest

7.19.3. Cevaplar

HTTP Kodu Açıklama Şema

200

successful operation

PaymentServiceResponse

7.19.4. Kullanılanlar

  • application/json

  • application/xml

7.19.5. Üretilenler

  • application/json

  • application/xml

7.19.6. Etiketler

  • payment

8. Tanımlar

8.1. ActiveContractMatchingRequestBody

Aktif Kontrat Eşleşme Sorgusu

İsim Açıklama Şema

contractNames
gerekli

Kontratlar

< string > array

8.2. ActiveContractMatchingResponseBody

Aktif Kontratlara Ait Eşleşme Sonucu

İsim Açıklama Şema

matchings
opsiyonel

< Match > array

8.3. AmountPrice

Miktar Fiyat İkilisi

İsim Açıklama Şema

amount
opsiyonel

Miktar

integer(int64)

owner
opsiyonel

Sahip
Varsayılan : false

boolean

price
opsiyonel

Fiyat

number

8.4. BidCancelRequestBody

Teklif İptal Servis İstek Yapısı

İsim Açıklama Şema

bidId
gerekli

Teklif Tekil Numarası

string

8.5. BidCancelResponseBody

Teklif İptal Servis Cevap Yapısı

İsim Açıklama Şema

bidResponse
opsiyonel

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

BidResponse

8.6. BidMatchStatusResponse

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

İsim Açıklama Şema

localization
gerekli

= {BID_MATCH_STATUS_LOCALIZATION}

LocalizationResponse

name
gerekli

= {BID_MATCH_STATUS_NAME}

string

8.7. BidResponse

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

İsim Açıklama Şema

id
opsiyonel

Teklif Tekil Numarası

string

8.8. BidSaveRequestBody

Teklif Oluşturma Servis İstek Yapısı

İsim Açıklama Şema

bidProcessName
opsiyonel

Teklif Süreç Adı

string

bidStatus
gerekli

Teklif Durumları
Örnek : "ACTIVE, PASSIVE, CANCEL, ACCEPTED, PROCESSING"

string

bidType
gerekli

Teklif Tipleri
Örnek : "MATCH_AND_DESTROY_REST, STANDART_MATCH, MATCH_WITH_TIME_LIMIT"

string

contractName
gerekli

Kontrat Adı
Örnek : "GG20180901"

string

direction
gerekli

Kontrat Yönü
Örnek : "BUY,SELL"

string

expireTime
opsiyonel

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

string(date-time)

pointName
opsiyonel

Teklif Noktası

string

price
opsiyonel

Fiyat
Örnek : 100.25

number

quantity
gerekli

Miktar
Örnek : 155

integer(int64)

8.9. BidSaveResponseBody

Teklif Oluşturma SErvis Cevap Yapısı

İsim Açıklama Şema

bidResponse
opsiyonel

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

BidResponse

8.10. BidStatusResponse

Teklif Durum Listesi Servis Cevabı

İsim Açıklama Şema

localization
gerekli

Teklif Durumları Yerelleştime

LocalizationResponse

name
gerekli

Teklif Durumları

string

8.11. BidTypeResponse

Teklif Tip Listesi Servis Cevabı

İsim Açıklama Şema

localization
gerekli

Teklif Tipleri Yerelleştime

LocalizationResponse

name
gerekli

Teklif Tipleri

string

8.12. BidUpdateReasonResponse

Telif Güncelleme Sebep Listesi Servis Cevabı

İsim Açıklama Şema

localization
gerekli

= {BID_UPDATE_REASON_LOCALIZATION}

LocalizationResponse

name
gerekli

= {BID_UPDATE_REASON_NAME}

string

8.13. BidUpdateRequestBody

Teklif Güncelleme Servis İstek Yapısı

İsim Açıklama Şema

bidId
gerekli

Teklif Tekil Numarası

string

bidStatus
gerekli

Teklif Durumları

string

price
opsiyonel

Fiyat

number

quantity
gerekli

Miktar

integer(int64)

8.14. BidUpdateResponseBody

Teklif Güncelleme Servis Cevap Yapısı

İsim Açıklama Şema

bidResponse
opsiyonel

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

BidResponse

8.15. ContractConfigurationGetRequestBody

Kontrat Konfigurasyonları Sorgulama Servis İsteği

İsim Açıklama Şema

contractName
gerekli

Kontrat Adı

string

8.16. ContractConfigurationGetResponseBody

Kontrat Konfigurasyonları Sorgulama Servis Cevabı

İsim Açıklama Şema

baseCoefficient
opsiyonel

Taban Fiyat Çarpım Katsayısı

number

ceilingCoefficient
opsiyonel

Tavan Fiyat Çarpım Katsayısı

number

contractConfId
opsiyonel

Kontrat Konfigurasyon Id

integer(int64)

dapFinalDate
opsiyonel

Gün Öncesi Fiyatı Kesinleşme Tarihi

string(date-time)

dapScopeDate
opsiyonel

Gün Öncesi Fiyatı Kapsam Tarihi

string(date-time)

gateList
opsiyonel

Kapı İşlemleri

< ContractGateResponse > array

grpFinalDate
opsiyonel

Gaz Referans Fiyatı Kesinleşme Tarihi

string(date-time)

grpScopeDate
opsiyonel

Gaz Referans Fiyatı Kapsam Tarihi

string(date-time)

lpa
opsiyonel

Son Fiyat Ortalaması (Eşleşme fiyatı)

integer(int64)

lqa
opsiyonel

Son Miktar Ortalaması (Eşleşme miktarı)

integer(int64)

marketBasePrice
opsiyonel

Piyasa Taban Fiyatı

number

marketCeilingPrice
opsiyonel

Piyasa Tavan Fiyatı

number

marketMaxQuantity
opsiyonel

Piyasa Max Miktarı

integer(int64)

marketMinQuantity
opsiyonel

Piyasa Min Miktarı

integer(int64)

nbpOpenTime
opsiyonel

Ulusal Dengeleme Noktası Açık Kalma Süresi

number

objectionTime
opsiyonel

İtiraz Zamanı

number

retrospectiveAverage
opsiyonel

Gaz Referans Fiyatı Geriye Dönük Ortalaması

number

transmissionBasePrice
opsiyonel

İletim Taban Fiyatı

number

transmissionBasePriceFormula
opsiyonel

İletim Taban Fiyat Hesaplama Formülü

string

transmissionCeilingPrice
opsiyonel

İletim Tavan Fiyatı

number

transmissionCeilingPriceFormula
opsiyonel

İletim Tavan Fiyat Hesaplama Formülü

string

transmissionMaxQuantity
opsiyonel

İletim Max Miktarı

integer(int64)

transmissionMinQuantity
opsiyonel

İletim Min Miktarı

integer(int64)

8.17. ContractConfigurationSaveRequestBody

Kontrat Konfigürasyonu Kaydetme Servis İsteği

İsim Açıklama Şema

average
opsiyonel

Gaz Referans Fiyatı Geriye Dönük Ortalaması

number

baseCoefficient
opsiyonel

Taban Fiyat Çarpım Katsayısı

number

ceilingCoefficient
opsiyonel

Tavan Fiyat Çarpım Katsayısı

number

contractName
gerekli

Kontrat Adı

string

dapFinalDate
gerekli

Gün Öncesi Fiyatı Kesinleşme Tarihi

string(date-time)

dapScopeDate
gerekli

Gün Öncesi Fiyatı Kapsam Tarihi

string(date-time)

grpFinalDate
gerekli

Gaz Referans Fiyatı Kesinleşme Tarihi

string(date-time)

grpScopeDate
gerekli

Gaz Referans Fiyatı Kapsam Tarihi

string(date-time)

lpa
opsiyonel

Son Fiyat Ortalaması (Eşleşme fiyatı)

integer(int64)

lqa
opsiyonel

Son Miktar Ortalaması (Eşleşme miktarı)

integer(int64)

marketBasePrice
opsiyonel

Piyasa Taban Fiyatı

number

marketCeilingPrice
opsiyonel

Piyasa Tavan Fiyatı

number

marketMaxQuantity
opsiyonel

Piyasa Max Miktarı

integer(int64)

marketMinQuantity
opsiyonel

Piyasa Min Miktarı

integer(int64)

modifyUser
opsiyonel

Değişiklik Yapan Kullanıcı

string

nbpOpenTime
opsiyonel

Ulusal Dengeleme Noktası Açık Kalma Süresi

number

objectionTime
opsiyonel

İtiraz Zamanı

number

transmissionBasePrice
opsiyonel

İletim Taban Fiyatı

number

transmissionBasePriceFormula
opsiyonel

İletim Taban Fiyat Hesaplama Formülü

string

transmissionCeilingPrice
opsiyonel

İletim Tavan Fiyatı

number

transmissionCeilingPriceFormula
opsiyonel

İletim Tavan Fiyat Hesaplama Formülü

string

transmissionMaxQuantity
opsiyonel

İletim Max Miktarı

integer(int64)

transmissionMinQuantity
opsiyonel

İletim Min Miktarı

integer(int64)

8.18. ContractConfigurationSaveResponseBody

Kontrat Konfigürasyonu Kaydetme Servis Cevabı

Tip : object

8.19. ContractDepthRequestBody

Kontrat Derinliği Servis İstek Yapısı

İsim Açıklama Şema

contractName
gerekli

Kontrat Adı

string

8.20. ContractDepthResponseBody

Kontrat Derinliği Servis Cevap Yapısı

İsim Açıklama Şema

contractBuyDepths
opsiyonel

< AmountPrice > array

contractSellDepths
opsiyonel

< AmountPrice > array

8.21. ContractDepthServiceResponse

Kontrat Derinliği Servis Cevap

İsim Açıklama Şema

body
opsiyonel

ContractDepthResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.22. ContractDepthSummaryResponse

Kontratlara Ait Teklif Derinliği Servis Cevabı

İsim Açıklama Şema

bidState
opsiyonel

Teklif State

StringType

bidStatus
opsiyonel

Teklif Durumu

BidStatusResponse

createDate
opsiyonel

Teklif Oluşturma Tarihi

string(date-time)

direction
opsiyonel

Teklif Yönü

DirectionResponse

lastMatchingsPriceAverage
opsiyonel

Son Eşleşmelere ait Fiyat Ortalaması

number

lastMatchingsQuantityAverage
opsiyonel

Son Eşleşmelere ait Miktar Ortalaması

integer(int64)

organization
opsiyonel

Organizasyon

StringType

organizationId
opsiyonel

Organizasyon Tekil Numarası

integer(int64)

price
opsiyonel

Teklif Fiyatı

number

quantity
opsiyonel

Teklif Miktarı

integer(int64)

remaingQuatity
opsiyonel

= {BID_REMAINING_QUANTITY}

integer(int64)

8.23. ContractDepthSummaryResponseBody

Kontratlara Ait Teklif Derinliği Servis Cevap İçeriği

İsim Açıklama Şema

contractDepthSummaryResponses
opsiyonel

< ContractDepthSummaryResponse > array

8.24. ContractDepthSummaryServiceResponse

Kontratlara Ait Teklif Derinliği Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

ContractDepthSummaryResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.25. ContractGateChangeStatusRequestBody

Kontrat Kapı Statü Güncelleme Servis İstek İçeriği

İsim Açıklama Şema

gateId
gerekli

Kapı Id

integer(int64)

gateStatusName
gerekli

Kontrat Kapı Durumu

string

8.26. ContractGateResponse

Kontrat Konfigurasyonları Sorgulama Servis Cevabı

İsim Açıklama Şema

announcementDate
opsiyonel

Kontrat Kapı Duyuru Zamanı

string(date-time)

contractGateId
opsiyonel

Kapı Id

integer(int64)

contractName
opsiyonel

Kontrat Adı

string

directionResponse
opsiyonel

Kontrat Yönü

DirectionResponse

endDate
opsiyonel

Kontrat Konfigurasyonları Kapı Bitiş Tarihi

string(date-time)

gateStatusResponse
opsiyonel

Kontrat İşlemleri Statüsü

ContractGateStatusResponse

gateTypeResponse
opsiyonel

Kontrat Konfigurasyonları Kapı Adı

ContractGateTypeResponse

quantity
opsiyonel

Kontrat Kapı Miktarı

integer(int64)

startDate
opsiyonel

Kontrat Konfigurasyonları Kapı Başlangıç Tarihi

string(date-time)

8.27. ContractGateStatusResponse

Kontrat Kapı Durumu Servis Cevabı

İsim Açıklama Şema

localization
gerekli

Kontrat Kapı Durumu Yerelleştirme

LocalizationResponse

name
gerekli

Kontrat Kapı Durumu

string

8.28. ContractGateTypeResponse

Kontrat Kapı Tipi

İsim Açıklama Şema

localization
gerekli

Kontrat Kapı Tipi Yerelleştirme

LocalizationResponse

name
gerekli

Kontrat Konfigurasyonları Kapı Adı

string

8.29. ContractGateUpdateRequestBody

Kontrat Kapı Tarihi Güncelleme Servis İsteği

İsim Açıklama Şema

endDate
opsiyonel

Kontrat Konfigurasyonları Kapı Bitiş Tarihi

string(date-time)

gateId
opsiyonel

Kapı Id

integer(int64)

startDate
opsiyonel

Kontrat Konfigurasyonları Kapı Başlangıç Tarihi

string(date-time)

8.30. ContractGetRequestBody

Kontrat Sorgulama Servis İsteği

İsim Açıklama Şema

contractName
gerekli

Kontrat Adı

string

8.31. ContractResponseBody

Aktif Kontratları Listeleme Servis Cevabı

İsim Açıklama Şema

contracts
opsiyonel

< ContractSummary > array

8.32. ContractSaveRequestBody

Kontrat Kaydetme Servis İsteği

İsim Açıklama Şema

contractTypeName
gerekli

Kontrat Tipi

string

directionName
gerekli

Kontrat Yönü

string

gasDayDate
opsiyonel

string(date-time)

gasDayDates
gerekli

Gaz Günleri

< string(date-time) > array

physicalPointIds
gerekli

Kontrat Fiziksel Noktaları

< integer(int64) > array

quantity
gerekli

Kontrat Miktarı

integer(int64)

8.33. ContractServiceResponseBody

Kontrat Sorgulama Servis Cevabı

İsim Açıklama Şema

activationDate
gerekli

Kontrat Aktifleştirme Tarihi

string(date-time)

closeDate
gerekli

Kontrat Kapama Tarihi

string(date-time)

contractName
gerekli

Kontrat Adı

string

contractStatus
gerekli

Kontrat Durumu

ContractStatusResponse

contractType
gerekli

Kontrat Tipi

ContractTypeResponse

createDate
gerekli

Kontrat Oluşturma Tarihi

string(date-time)

direction
gerekli

Kontrat Yönü

DirectionResponse

gasDays
gerekli

Gaz Günleri

< GasDayResponse > array

physicalPointIds
gerekli

Kontrat Fiziksel Noktaları

< integer(int64) > array

quantity
gerekli

Kontrat Miktarı

integer(int64)

8.34. ContractStatusListRequestBody

Kontrat Durum Listeleme Servis İsteği

Tip : object

8.35. ContractStatusListResponse

Kontrat Durum Listeleme Servis Cevabı

İsim Açıklama Şema

contractStatuses
opsiyonel

< ContractStatusResponse > array

8.36. ContractStatusResponse

Kontrat Durum Listeleme Servis Cevabı

İsim Açıklama Şema

localization
gerekli

Kontrat Durum Yerelleştirme

LocalizationResponse

name
gerekli

Kontrat Durum Adı

string

8.37. ContractSummary

Kontrat Özeti

İsim Açıklama Şema

activationTime
gerekli

Kontrat Aktifleştirme Tarihi

string(date-time)

bestAmountPriceBuying
gerekli

En İyi Alış

AmountPrice

bestAmountPriceSelling
gerekli

En İyisi

AmountPrice

closingTime
gerekli

Kontrat Kapanış Zamanı

string(date-time)

deliveryDays
gerekli

Gaz Teslim Günleri

< string(date-time) > array

gasDays
gerekli

Gaz Günleri

< GasDay > array

highestMatchingPrice
gerekli

En Yüksek Eşleşme Fiyatı

number

lastMatchingPrice
gerekli

Son Eşleşme Fiyatı

number

lastMatchingPriceDirection
gerekli

Kontrat Fiyat Eşleşme Yönü

enum (UP, DOWN, IDLE)

name
gerekli

Kontrat Adı

string

status
gerekli

Kontrat Statüsü

StringType

type
gerekli

Tip

StringType

weightedAverage
gerekli

Ağırlıklı Ortalama

number

weightedAverageDirection
gerekli

Kontrat Fiyat Eşleşme Yönü

enum (UP, DOWN, IDLE)

8.38. ContractTypeResponse

Kontrat Tip Listeleme Servis Cevabı

İsim Açıklama Şema

localization
gerekli

Kontrat Tipi Yerelleştirme

LocalizationResponse

name
gerekli

Kontrat Tipi

string

8.39. DirectionResponse

Kontrat Yönü Listeleme Servis Cevabı

İsim Açıklama Şema

localization
gerekli

Kontrat Yönü Yerelleştirme

LocalizationResponse

name
gerekli

Kontrat Yönü

string

8.40. EmptyRequestBody

Tip : object

8.41. GasDay

Gaz Günü

İsim Açıklama Şema

advancePaymentDate
opsiyonel

Avans Ödeme Günü

string(date-time)

gasDayDate
opsiyonel

Gaz Günü

string(date-time)

gasDayId
opsiyonel

Gaz Günü ID

integer(int64)

gasDeliveryEndDate
opsiyonel

Gaz Günü Bitiş Tarihi

string(date-time)

gasDeliveryStartDate
opsiyonel

Gaz Günü Başlangıç Tarihi

string(date-time)

registrationPeriodId
opsiyonel

Gaz Günü Kayıt Period ID

integer(int64)

8.42. GasDayResponse

Gaz Günü Listeleme Servis Cevabı

İsim Açıklama Şema

advancePaymentDate
gerekli

Avans Ödeme Günü

string(date-time)

gasDayDate
gerekli

Gaz Günü

string(date-time)

gasDayId
gerekli

Gaz Günü ID

integer(int64)

gasDeliveryEndDate
gerekli

Gaz Günü Bitiş Tarihi

string(date-time)

gasDeliveryStartDate
gerekli

Gaz Günü Başlangıç Tarihi

string(date-time)

registrationPeriodId
gerekli

Gaz Günü Kayıt Period ID

integer(int64)

8.43. GrpPriceGetRequestBody

GRP Değerinin Hesaplanması Servis İsteği

İsim Açıklama Şema

contractType
gerekli

Kontrat Tipi

string

gasDay
gerekli

Gaz Günü

string(date-time)

8.44. GrpPriceResponseBody

GRP Değerinin Hesaplanması Servis Cevabı

İsim Açıklama Şema

basePrice
opsiyonel

number

ceilingPrice
opsiyonel

number

8.45. Header

Header request bilgisini tutar.

İsim Açıklama Şema

key
opsiyonel

Header key bilgisini tutar.
Örnek : "transactionId"

string

value
opsiyonel

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

string

8.46. LocalizationResponse

Yerelleştirme Servis Cevabı

İsim Açıklama Şema

language
gerekli

Yerelleştirme Dili

string

text
gerekli

Yerelleştirme Metni

string

8.47. Match

Eşleşme

İsim Açıklama Şema

contract
gerekli

Kontrat Adı

string

matchId
gerekli

Eşleşme No

string

matchStatus
gerekli

Eşleşme Durumu

string

matchingTime
gerekli

Eşleşme Zamanı

string(date-time)

myOwnMatching
gerekli

Kendi Eşleşmem
Varsayılan : false

boolean

pointName
opsiyonel

Teklif Noktası

string

price
gerekli

Fiyat

number

quantity
gerekli

Miktar

integer(int64)

8.48. MatchChangeStatusRequestBody

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

İsim Açıklama Şema

description
gerekli

Eşleşme durumunu değiştirme servisidir.

string

matchId
gerekli

Eşleşme Tekil Numarası

string

statusName
gerekli

Eşleşme Durumu

string

8.49. MatchChangeStatusRequestListBody

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

İsim Açıklama Şema

matchList
opsiyonel

< MatchChangeStatusRequestBody > array

8.50. MatchListResponse

Eşleşme Listesi Servis Cevabı

İsim Açıklama Şema

matchList
opsiyonel

< MatchResponse > array

8.51. MatchReasonResponse

EŞleşme Neden Listesi Servis Cevabı

İsim Açıklama Şema

localization
gerekli

Eşleşme Nedeni Yerelleştirme

LocalizationResponse

name
gerekli

Eşleşme Nedeni

string

8.52. MatchResponse

Eşleşme Listesi Servis Cevabı

İsim Açıklama Şema

contractName
gerekli

Kontrat Adı

string

createDate
gerekli

Eşleşme Oluşma Tarihi

string(date-time)

createUser
gerekli

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

string

matchId
gerekli

Eşleşme Tekil Numarası

string

matchStatus
gerekli

= {MATCH_STATUS}

MatchStatusResponse

price
gerekli

Eşleşme Fiyatı

number

purchaseBid
gerekli

Eşleşme Alış Teklifi

BidResponse

purchaseMatchReason
gerekli

Alış Teklifi Eşleşme Nedeni

MatchReasonResponse

quantity
gerekli

Eşleşme Miktarı

integer(int64)

saleBid
gerekli

Eşleşme Satış Teklifi

BidResponse

saleMatchReason
gerekli

Satış Teklifi Eşleşme Nedeni

MatchReasonResponse

8.53. MatchStatusResponse

Eşleşme Durumu Servis Cevabı

İsim Açıklama Şema

localization
gerekli

Eşleşme Durumu Yerelleştirme

LocalizationResponse

name
gerekli

Eşleşme Durumu

string

8.54. PaymentOrder

Ödeme Talebi

İsim Açıklama Şema

amount
gerekli

Ödeme Tutarı

number

eic
gerekli

ETSO Kod

string

paymentOrderId
gerekli

Talep No

integer(int64)

requestTime
gerekli

Para Çekme İsteği Zamanı
Örnek : "2017-02-07T09:31:33.000+03:00"

string(date-time)

8.55. PaymentOrderRequestBody

Ödeme Talebi İsteği

İsim Açıklama Şema

orders
opsiyonel

< PaymentOrder > array

8.56. PaymentOrderResult

Ödeme Talebi Sonucu

İsim Açıklama Şema

amount
gerekli

Ödeme Tutarı

number

eic
gerekli

ETSO Kod

string

paymentOrderId
gerekli

Talep No

integer(int64)

status
gerekli

Talep Statüsü

StringType

8.57. PaymentResponseBody

Ödeme Talebi Cevabı

İsim Açıklama Şema

results
opsiyonel

< PaymentOrderResult > array

8.58. PaymentServiceResponse

Ödeme Talebi Cevabı

İsim Açıklama Şema

body
opsiyonel

PaymentResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.59. RegionalContractResponseBody

Bölgesel Aktif Kontractlar Servis Cevabı

İsim Açıklama Şema

contracts
opsiyonel

< RegionalContractSummary > array

8.60. RegionalContractSummary

Noktasal Bölgesel Kontratlar

İsim Açıklama Şema

activationTime
gerekli

Kontrat Aktifleştirme Tarihi

string(date-time)

bestAmountPriceBuying
gerekli

En İyi Alış

AmountPrice

bestAmountPriceSelling
gerekli

En İyisi

AmountPrice

closingTime
gerekli

Kontrat Kapanış Zamanı

string(date-time)

deliveryDays
gerekli

Gaz Teslim Günleri

< string(date-time) > array

direction
opsiyonel

Yön

string

gasDays
gerekli

Gaz Günleri

< GasDay > array

locations
gerekli

Noktalar

< string > array

name
gerekli

Kontrat Adı

string

remainingAmount
gerekli

Kalan Miktar

integer(int64)

status
gerekli

Kontrat Statüsü

StringType

totalAmount
gerekli

Toplam Miktar

integer(int64)

type
gerekli

Tip

StringType

8.61. StringType

String Tipi

İsim Açıklama Şema

text
gerekli

Metin

string

value
gerekli

Değer

string

8.62. activeContractMatchingRequest

Aktif Kontrat Eşleşme Sorgusu

İsim Açıklama Şema

body
opsiyonel

ActiveContractMatchingRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.63. activeContractMatchingResponse

Aktif Kontratlara Ait Eşleşme Sonucu

İsim Açıklama Şema

body
opsiyonel

ActiveContractMatchingResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.64. bidCancelServiceRequest

Teklif İptal Servis İsteği

İsim Açıklama Şema

body
opsiyonel

BidCancelRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.65. bidCancelServiceResponse

Teklif İptal Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

BidCancelResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.66. bidSaveServiceRequest

Teklif Kaydetme Servis İsteği

İsim Açıklama Şema

body
opsiyonel

BidSaveRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.67. bidSaveServiceResponse

Teklif Kaydetme Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

BidSaveResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.68. bidUpdateServiceRequest

Teklif Güncelleme Servis İsteği

İsim Açıklama Şema

body
opsiyonel

BidUpdateRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.69. bidUpdateServiceResponse

Teklif Güncelleme Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

BidUpdateResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.70. contractConfigurationGetServiceRequest

Kontrat Konfigurasyonları Sorgulama Servis İsteği

İsim Açıklama Şema

body
opsiyonel

ContractConfigurationGetRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.71. contractConfigurationGetServiceResponse

Kontrat Konfigurasyonları Sorgulama Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

ContractConfigurationGetResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.72. contractConfigurationSaveServiceRequest

Kontrat Konfigürasyonu Kaydetme Servis İsteği

İsim Açıklama Şema

body
opsiyonel

ContractConfigurationSaveRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.73. contractConfigurationSaveServiceResponse

Kontrat Konfigürasyonu Kaydetme Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

ContractConfigurationSaveResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.74. contractDepthServiceRequest

Kontrat Derinliği Servis Cevabı

İsim Açıklama Şema

body
gerekli

ContractDepthRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.75. contractGateChangeStatusServiceRequest

Kontrat Kapı Statü Güncelleme Servis İsteği

İsim Açıklama Şema

body
opsiyonel

ContractGateChangeStatusRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.76. contractGateSaveServiceResponse

Kontrat Kapı Kaydetme Sservis Cevabı

İsim Açıklama Şema

body
opsiyonel

ContractGateResponse

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.77. contractGateUpdateServiceRequest

Kontrat Kapı Tarihi Güncelleme Servis İsteği

İsim Açıklama Şema

body
opsiyonel

ContractGateUpdateRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.78. contractGetServiceRequest

Kontrat Sorgulama Servis İsteği

İsim Açıklama Şema

body
opsiyonel

ContractGetRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.79. contractGetServiceResponse

Kontrat Sorgulama Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

ContractServiceResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.80. contractRequest

Aktif Kontratları Listeleme Servis İsteği

İsim Açıklama Şema

body
opsiyonel

EmptyRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.81. contractResponse

Aktif Kontratları Listeleme Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

ContractResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.82. contractSaveServiceRequest

Kontrat Sorgulama Servis İsteği

İsim Açıklama Şema

body
opsiyonel

ContractSaveRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.83. contractSaveServiceResponse

Kontrat Kaydetme Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

ContractServiceResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.84. contractStatusListServiceRequest

Kontrat Durum Listeleme Servis İsteği

İsim Açıklama Şema

body
opsiyonel

ContractStatusListRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.85. contractStatusListServiceResponse

Kontrat Durum Listeleme Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

ContractStatusListResponse

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.86. grpPriceGetRequest

GRP Değerinin Hesaplanması Servis İsteği

İsim Açıklama Şema

body
gerekli

GrpPriceGetRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.87. grpPriceServiceResponse

GRP Değerinin Hesaplanması Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

GrpPriceResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.88. matchChangeStatusServiceRequest

Eşleşme Durum Değiştirme Servis İsteği

İsim Açıklama Şema

body
opsiyonel

MatchChangeStatusRequestListBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.89. matchChangeStatusServiceResponse

Eşleşme Durum Değiştirme Servis Sonucu

İsim Açıklama Şema

body
opsiyonel

MatchListResponse

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

8.90. paymentOrderServiceRequest

Ödeme Talebi İsteği

İsim Açıklama Şema

body
opsiyonel

PaymentOrderRequestBody

headers
opsiyonel

Header request bilgisini tutar.

< Header > array

8.91. regionalContractResponse

Bölgesel Aktif Kontractlar Servis Cevabı

İsim Açıklama Şema

body
opsiyonel

RegionalContractResponseBody

resultCode
gerekli

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

string

resultDescription
gerekli

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

string

resultType
gerekli

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

enum (SUCCESS, BUSINESSERROR, SYSTEMERROR, SECURITYERROR)

transactionId
opsiyonel

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

string

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