EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
BOTAŞ EBT BİLGİ YÖNETİM SİSTEMİ
WEB SERVİSLERİ
KULLANIM KLAVUZU
14.04.2014
Sürüm: 3.0.0
Sayfa 1 / 12
EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
Güncellenen Bölümler
Sürüm
Yayınlanma Tarihi
Güncellenen Bölümler
2.2.2
27.02.2014
EBTANLIKAKISDVO Tablosundaki
 Özellik Adı ANLIKKUMULATIFAKIS_STDM3 yerine
ANLIKAKIS_STDM3 olarak güncellenmiştir.
 Açık Adı Anlık Kümülatif Akış yerine Anlık Akış olarak
güncellenmiştir.
 Açıklama kısmında yer alan “Saat 08:00’den ölçüm zamanına
kadar gerçekleşen toplam akışı ifade eder. (Stdm3)” ifadesi
silinmiş, “Ölçüm zamanındaki saatlik gerçekleşen toplam akışı
ifade eder( Stdm3)” eklenmiştir
EBTSAATLIKAKISDVO Tablosundaki
KUMULATIFAKIS_STDM3 Özelliğinin;
 Açıklama kısmında yer alan “Ölçüm zamanındaki saatlik
gerçekleşen toplam akışı ifade eder( Stdm3)” ifadesi silinmiş,
“Saat 08:00’den ölçüm zamanına kadar gerçekleşen toplam akışı
ifade eder. (Stdm3)” eklenmiştir
EBTGUNSONUKAKISDVO Tablosundaki
USTISILDEGER_KCAL_PER_SM3 Özelliğinin;
 Açıklama kısmında yer alan ifade “İstasyonun günlük akış
ağırlıklı ortalama üst ısıl değerini ifade eder.(KCAL/Sm3)”
şeklinde güncellenmiştir.
Sürüm
Yayınlanma Tarihi
Güncellenen Bölümler
3.0.0
14.04.2014
 KALITEDEGERIGONDER metodu eklenmiştir.
Giriş
EBT Sisteminin, Web Servisleri birinci versiyonu, BOTAŞ ile yapılan ayrıştırma çalışmalarına
paralel olarak geliştirilmiştir.
Servisler, EBT Sistemindeki aktörler(Taşıtanlar, Dağıtım Şirketleri) tarafından kullanılacaktır.
Bu döküman, EBT Web Servisleri’ne entegre olacak kurumlar için klavuz niteliği taşımaktadır.
Web Servisleri metotları, bu metotların giriş ve çıkış parametreleri, dökümanda detaylı olarak
açıklanmaktadır.
Döküman, sırasıyla




Genel Bilgiler
Kullanıcı adı ve şifreler,
Süreçler ve metotları,
Metot detay açıklamaları
Sayfa 2 / 12
EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
Bölümlerini içermektedir.
1. Genel Bilgiler
EBT Sistemi, Visual Studio .NET ortamında Framework 4.0 kullanılarak geliştirilmiştir.
Skada yazılımlarında EBT Web Servislerine adaptaston çalışmalarının yapılabilmesi için ilk
olarak test ortamında sunulacaktır. Daha sonra gerçek ortama alınacaktır.
Yeni versiyon duyuruları önce test ortamı için yapılacak, versiyon gerçek ortama geçirilmeden
bir hafta öncesinden duyurulacaktır. İlgililerin duyuruları takip etmeleri ve versiyon güncellemelerini
kendi yazılımlarına test ortamında eklemelidirler.
2. Kullanıcı Adı ve Şifreler
EBT Web Servislerine kullanıcı adı ve şifre ile ulaşılacaktır.
Kullanıcı adı ve şifre her kurumun kendine ait olacaktır.
Dağıtım şirketleri için gereken Kullanıcı Kodu ve Parola (Kullanıcı adı ve Şifre) BOTAŞ Doğalgaz İşletmeleri
Bölge Müdürlüğü tarafından gereken yasal süreci tamamlayan şirketlere elden teslim edilmektedir. Konu
ile ilgili detaylı bilgi için (312) 297 36 00 telefon numarasından Gaz İletim Müdürlüğü Yetkilileri ile
görüşülebilir.
Web Servislerine Şifre Gönderilmesi


WCF (Windows Communication Service) transport level message security,
ServiceCredentials X509Certificate,
kullanılarak kullanıcı adı ve şifre doğrulama gerçekleştirilmektedir.
3. Süreçler ve Metotlar
Bu bölümde EBT Sistemine veri gönderebilmek için kullanılacak web servis metotları
açıklanmaktadır.
Web Servis Metotları aşağıdaki gibidir:
ANLIK AKIŞ
ANLIKAKISGONDER
TOPLUANLIKAKISGONDER
SAATLİK AKIŞ
SAATLIKAKISGONDER
GÜNLÜK AKIŞ
GUNSONUAKISGONDER
NOKTA BELİRLEME
NOKTALARIGETIR
4. Web Servis Metotları Detay Açıklamaları
Bu bölümde EBT Web Servis metotlarının giriş ve çıkış parametreleri açıklanmaktadır.
4.1. Anlık Akış Metotları
4.1.1. ANLIKAKISGONDER METODU
Anlık Akış verilerinin gönderildiği metottur.
Metot Adı
ANLIKAKISGONDER
Giriş Parametresi
EBTANLIKAKISDVO
Çıkış Parametresi
ANLIKAKISSONUCDVO
Sayfa 3 / 12
EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
Tablo 4.1.1.a: EBTANLIKAKISDVO
Özellik Adı
Açık
Adı
Kurum
Kodu
Tipi
Uzunluk
Zorunlu
Açıklama
string
32
Evet
Kurumunuza ait kurum kodunuzu ifade
eder.
NOKTAKODU
Nokta
Kodu
string
32
Evet
Verisi gönderilen noktanın EBT
sistemindeki kodunu ifade eder.
OLCUMZAMANI
Ölçüm
Zaman
ı
DateTime
Evet
Ölçümün yapıldığı tarihsaati (dd.mm.yyyy
hh:mm:ss) ifade eder.
ANLIKAKIS_STDM3_PERHOUR
Anlık
Akış
decimal
Evet
Ölçüm zamanındaki akış hızını ifade eder.
(Stdm3/saat)
ANLIKKUMULATIFAKIS_STDM3
Anlık
Kümül
atif
Akış
decimal
Evet
Saat 08:00’den ölçüm zamanına kadar
gerçekleşen toplam akışı ifade eder.
(Stdm3)
Ölçüm zamanındaki saatlik gerçekleşen
toplam akışı ifade eder( Stdm3)
USTISILDEGER_KCAL_PER_SM3
Üst Isıl
Değer
Decimal
Evet
(Kcal/Sm3)
ENERJI_KCAL
Enerji
Decimal
Evet
Kcal
BASINC_BARG
Basınç
decimal
Evet
Ölçüm zamanındaki istasyon giriş
basıncını ifade eder. (BARG)
SICAKLIK_C
Sıcaklı
k
decimal
Evet
Ölçüm zamanındaki istasyon giriş
sıcaklığını ifade eder. (C)
KURUMKODU
Sayfa 4 / 12
EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
Tablo 4.1.1.b: ANLIKAKISSONUCDVO
Özellik Adı
Açık Adı
Tipi
Uzunluk
Açıklama
ANLIKKOD
ANLIK
KOD
string
32
Gönderdiğiniz verinin, EBT Sistemi tarafından
üretilen, takip numarasıdır.
HATAVAR
HATAVAR
Bool
Gönderim işleminin sonucu.
false ise gönderim işlemi başarılıdır.
true ise gonderim işlemi hatalıdır.
HATA
HATA
HATA
Gönderim işleminin sonucu hatalı ise,
HATAVAR özelliği true, hata kodu ve açıklaması
verilir Bkz Tablo E
4.1.2. TOPLUANLIKAKISGONDER METODU
Anlık Akis verilerinin toplu olarak gönderilebildiği metottur.
Metot Adı
TOPLUANLIKAKISGONDER
Giriş Parametresi
EBTANLIKAKISDVO[] Bkz. Tablo
4.1.1.a
Çıkış Parametresi
ANLIKAKISSONUCDVO[] Bkz.
Tablo 4.1.1.b
4.2. Saatlik Akış Metotları
4.2.1. SAATLIKAKISGONDER METODU
Saatlik Akış verilerinin gönderildiği mettottur.
Metot Adı
SAATLIKAKISGONDER
Giriş Parametresi
EBTSAATLIKAKISDVO
Çıkış Parametresi
SAATLIKAKISSONUCDVO
Tablo 4.2.1.a: EBTSAATLIKAKISDVO
Özellik Adı
Açık Adı
Tipi
Uzunluk
Zorunlu
Açıklama
KURUMKODU
Kurum
Kodu
string
32
Evet
Kurumunuza ait kurum kodunuzu ifade
eder.
NOKTAKODU
Nokta
Kodu
string
32
Evet
Verisi gönderilen noktanın EBT
sistemindeki kodunu ifade eder.
OLCUMZAMANI
Ölçüm
Zamanı
DateTime
Evet
Ölçümün yapıldığı saat aralığını
(dd.mm.yyyy hh:00:00) ifade eder.
ÖR:19.07.2013 16:00:00 ÖLÇÜM ZAMANI
(19.07.2013 15:00:00 İLE 19.07.2013
16:00:00) ARALIĞINI İFADE EDER
Sayfa 5 / 12
EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
KUMULATIFAKIS_STDM3
Kümülatif
Akış
decimal
Evet
Ölçüm zamanındaki saatlik gerçekleşen
toplam akışı ifade eder( Stdm3)
Saat 08:00’den ölçüm zamanına kadar
gerçekleşen toplam akışı ifade eder.
(Stdm3)
Kcal/Sm3
USTISILDEGER_KCAL_PER_S
M3
Üst Isıl
Değer
decimal
Evet
ENERJI_KCAL
Kümülatif
Enerji
decimal
Evet
Ölçüm zamanındaki saatlik gerçekleşen
toplam enerjiyi ifade eder(KCAL)
BASINC_BARG
Basınç
decimal
Evet
Ölçüm zamanındaki istasyonun ortalama
giriş basıncını ifade eder (BARG)
SICAKLIK_C
Sıcaklık
decimal
Evet
Ölçüm zamanındaki istasyonun ortalama
giriş sıcaklığını ifade eder. (C)
Tablo 4.2.1.b: SAATLIKAKISSONUCDVO
Özellik Adı
Açık Adı
Tipi
Uzunluk
Açıklama
SAATLIKKOD
SAATLİK
KOD
string
32
Gönderdiğiniz verinin, EBT Sistemi
tarafından üretilen, takip numarasıdır.
HATAVAR
HATAVAR
Bool
Gönderim işleminin sonucu.
false ise gönderim işlemi başarılıdır.
true ise gonderim işlemi hatalıdır.
HATA
HATA
HATA
Gönderim işleminin sonucu hatalı ise,
HATAVAR özelliği true, hata kodu ve
açıklaması verilir Bkz Tablo E
Sayfa 6 / 12
EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
4.3. Günlük Akış Metotları
4.3.1. GUNSONUAKISGONDER METODU
Günsonu akış verilerinin gönderildiği metottur.
Metot Adı
GUNSONUAKISGONDER
Giriş Parametresi
EBTGUNSONUKAKISDVO
Çıkış Parametresi
GUNSONUAKISSONUCDVO
Tablo 4.3.1.a: EBTGUNSONUKAKISDVO
Özellik Adı
Açık Adı
Tipi
Uzunluk
Zorunlu
Açıklama
KURUMKODU
Kurum
Kodu
string
32
Evet
Kurumunuza ait kurum kodunuzu
ifade eder.
NOKTAKODU
Nokta Kodu
string
32
Evet
Verisi gönderilen noktanın EBT
sistemindeki kodunu ifade eder.
GAZGUNU
Gaz Günü
DateTime
Evet
Verinin ait olduğu GAZ GÜNÜNÜ
ifade eder. dd.MM.yyyy 00:00:00
formatında olmalıdır.
AKISTOPLAMI_STDM3
Günsonu
Akış
Toplamı
decimal
Evet
İstasyonun
günlük
gerçekleşen
toplam akışını ifade eder( Stdm3)
ENERJITOPLAMI_KCAL
Kümülatif
Enerji
decimal
Evet
İstasyonun günlük gerçekleşen
toplam enerjisini ifade eder(KCAL)
USTISILDEGER_KCAL_PER_SM3
Üst Isıl
Değer
decimal
Evet
İstasyonun günlük akış ağırlıklı
ortalama üst ısıl değerini ifade
eder.(KCAL/Sm3)
ORTALAMABASINC_BARG
Akış
Ağırlıklı
Ortalama
Giriş
Basıncı
Akış
Ağırlıklı
Ortalama
Giriş
Sıcaklığı
decimal
Evet
İstasyonun günlük akış ağırlıklı
ortalama giriş basıncını ifade eder
(BARG)
decimal
Evet
İstasyonun günlük akış ağırlıklı
ortalama giriş sıcaklığını ifade eder.
(C)
ORTALAMASICAKLIK_C
Sayfa 7 / 12
EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
Tablo 4.3.1.b: GUNSONUAKISSONUCDVO
Özellik Adı
Açık Adı
Tipi
Uzunluk
Açıklama
GUNSONUKOD
GÜNSONU KOD
string
32
Gönderdiğiniz verinin, EBT Sistemi
tarafından üretilen, takip numarasıdır.
HATAVAR
HATAVAR
Bool
Gönderim işleminin sonucu.
false ise gönderim işlemi başarılıdır.
true ise gonderim işlemi hatalıdır.
HATA
HATA
HATA
Gönderim işleminin sonucu hatalı ise,
HATAVAR özelliği true, hata kodu ve
açıklaması verilir Bkz Tablo E
Sayfa 8 / 12
EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
4.4. Nokta Belirleme
4.4.1. NOKTALARIGETIR METODU
İlgili Kurumun sorumlu olduğu ve sistemde kayıtlı olan noktaların bilgilerinin talep
edildiği metottur. NOKTA array’i döndürür.
Metot adı
NOKTALARIGETIR
Giriş Parametresi
KURUMKODU
Çıkış Parametresi
NOKTA[]
4.5. Kalite Metotları
4.5.1. KALITEDEGERIGONDER METODU
Kalite verilerinin gönderildiği metottur. Bu metot Saat 08:00 – 15:00 arasında veri kabul
eder.
Metot Adı
KALITEDEGERIGONDER
Giriş Parametresi
EBTKALITEDVO
Çıkış Parametresi
KALITESONUCDVO
Tablo 4.5.1.a: EBTKALITEDVO
Özellik Adı
Açık Adı
Tipi
Uzunluk
Zorunlu
Açıklama
KURUMKODU
Kurum Kodu
string
32
Evet
Kurumunuza ait kurum kodunuzu
ifade eder.
NOKTAKODU
Nokta Kodu
string
32
Evet
Verisi gönderilen noktanın EBT
sistemindeki kodunu ifade eder.
GAZGUNU
Gaz Günü
DateTi
me
Evet
Verinin ait olduğu GAZ GÜNÜNÜ
ifade eder. dd.MM.yyyy 00:00:00
formatında olmalıdır.
AZOT
Azot
decimal
Evet
0-5.8 arasında değer alabilir.
Birimi mol%
BUTAN
Bütan
decimal
Evet
0-2.5 arasında değer alabilir.
Birimi mol%
ETAN
Etan
decimal
Evet
0-12 arasında değer alabilir.
Birimi mol%
Sayfa 9 / 12
EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
HIDROJENSULFUR
Hidrojen
Sülfür
decimal
Hayır
0-5.35 arasında değer alabilir.
Birimi mg/m3
HIDROKARBONCIGLENMENOKTASI
Hidrokarbon
çiğlenme
noktası
decimal
Hayır
-70 - 100 arasında değer alabilir.
Birimi (C)
KARBONDIOKSIT
Karbondioksi
t
decimal
Evet
0-3 arasında değer alabilir.
Birimi mol%
MERKAPTANKUKURT
Merkaptan
Kükürt
decimal
Hayır
0-16.07 arasında değer alabilir.
Birimi mol%
METAN
Metan
decimal
Evet
82-100 arasında değer alabilir.
Birimi mol%
OKSIJEN
Oksijen
decimal
Evet
0-0.5 arasında değer alabilir.
Birimi mol%
PENTANVEDIGERAGIRKARBONLAR
Pentan ve
Diğer
Ağırkarbonlar
decimal
Evet
0-1 arasında değer alabilir.
Birimi mol%
PROPAN
Proan
decimal
Evet
0-4 arasında değer alabilir.
Birimi mol%
SUCIGLENMENOKTASI
Su çiğlenme
Noktası
decimal
Hayır
-70 - 100 arasında değer alabilir.
Birimi (C)
USTISILDEGER
Üst Isıl Değer
decimal
Evet
8100-10427 arasında değer alabilir.
Birimi Kcal/m3
WOBBESAYISI
Wobbe Sayısı
decimal
Hayır
10465-13000 arasında değer alabilir.
Birimi Kcal/m3
Sayfa 10 / 12
EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
Tablo 4.5.1.b: KALITESONUCDVO
Özellik Adı
Açık Adı
Tipi
Uzunluk
Açıklama
KALITEKOD
KALİTE KOD
string
32
Gönderdiğiniz verinin, EBT Sistemi
tarafından üretilen, takip numarasıdır.
HATAVAR
HATAVAR
Bool
Gönderim işleminin sonucu.
false ise gönderim işlemi başarılıdır.
true ise gonderim işlemi hatalıdır.
HATA
HATA
HATA
Gönderim işleminin sonucu hatalı ise,
HATAVAR özelliği true, hata kodu ve
açıklaması verilir Bkz Tablo E
Sayfa 11 / 12
EBT Web Servisleri Kullanım Kılavuzu
COPYRIGHT @
Tablo E : HATA
Özellik Adı
Açık Adı
Tipi
Uzunluk
Açıklama
KOD
HATA KODU
string
İşlemin başarısız olması durumunda
işleme göre üretilen hata kodudur.
ACIKLAMA
HATAVAR
Bool
İşlemin başarısız olması durumunda,
oluşan hatanın detayıdır.
5. Sık Sorulan Sorular
5.1. EBT Web Servisleri gerçek ortam URL adresleri;
http://ebtws.botas.gov.tr/krizma.botas.ebt.akis.svc
5.2. EBT Web Servisleri test ortam URL adresleri;
http://ebtws.botas.gov.tr/krizma.botas.ebt.akis.svc
5.3. EBT Web Servislerini kullanmak için gerekli olan bilgiler nelerdir?
KURUMKODU, KURUMPAROLA ve NOKTAKODLARI gerekmektedir. Bu bilgileri BOTAŞ Bilgi
İşlem Müdürlüğünden temin edebilirsiniz.
ÖRNEK GÜN SONU AKIŞ CODE BİLGİSİ
ebtservice.AKISSERVICEClient c = new ebtservice.AKISSERVICEClient();
c.ClientCredentials.UserName.UserName = "KURUMKODU";
c.ClientCredentials.UserName.Password = "KURUMPAROLA";
c.ClientCredentials.ServiceCertificate.Authentication.CertificateValidationMode =
System.ServiceModel.Security.X509CertificateValidationMode.None;
ebtservice.EBTGUNSONUKAKISDVO akis = new ebtservice.EBTGUNSONUKAKISDVO();
akis.NOKTAKODU = "NOKTAKODU";
akis.KURUMKODU = "KURUMKODU";
akis.GAZGUNU = Convert.ToDateTime("26.12.2013 00:00:00");
akis.AKISTOPLAMI_STDM3 = (decimal) 10000000.12;
akis.ORTALAMABASINC_BARG = (decimal)123.15;
akis.ORTALAMASICAKLIK_C = (Decimal)12.12;
akis.USTISILDEGER_KCAL_PER_SM3 = (Decimal)8500.4548;
akis.ENERJITOPLAMI_KCAL=(Decimal)85004549020,05;
ebtservice.GUNSONUAKISSONUCDVO sonuc = null;
try
{
sonuc = c.GUNSONUAKISGONDER(akis);
if (sonuc.HATAVAR == false)
{
string GUNSONUKOD = sonuc.GUNSONUKOD;
}
}
catch (Exception EX)
{
string hata = EX.ToString();
}
Sayfa 12 / 12
Download

BOTAŞ EBT BİLGİ YÖNETİM SİSTEMİ WEB SERVİSLERİ