SOAP WS · Kullanım Sorgulama WS

Kullanım Sorgulama (GetUsage)

SOAPGetUsageRequest

Özel entegratör sistemi üzerinden kullanım tutarlarının sorgulandığı servistir.
PERIOD parametresi ile özel bir perioda dair sorgulama yapılabilinir.
PRODUCT_TYPE ile sadece seçtiğiniz ürüne dair kullanım detaylarını görebilirsiniz.
DIRECTION parametresi ile seçtiğiniz ürünün gelen, giden veya hem gelen hem giden toplam kullanımını inceleyebilirsiniz.
EARSIV, ESMM, EMM, EMUTABAKAT, SMS ve MAIL kullanımları sadece gönderim yapıldığından, sorgulanırken DIRECTION parametresi INBOX verilemez.

Ad	Tip	Zorunlu	Aciklama
`REQUEST_HEADER`	`object`	Evet	Request Header objesi içerisinde SESSION_ID ve APPLICATION_NAME alanı zorunludur.
└ `SESSION_ID`	`text`	Evet	Kimlik doğrulama servisi (AuthenticationWS) oturum açma metodundan (Login) alına oturum/token/session bilgisi.
└ `CLIENT_TXN_ID`	`text`	Hayir	İstemci uygulama tarafından işlem için üretilen işlem bilgisi (transaction id) varsa istek esnasında gönderilip, sonuçta alabileceğiniz bir değerdir. request/response eşleşmesi yapmak için kullanılabilir.
└ `APPLICATION_NAME`	`text`	Evet	Metodu çağıran uygulamanın adı. Örnek: AppName-v1.4.67
└ `COMPRESSED`	`text`	Hayir	İçerikte taşınan bilginin ZIP formatında sıkıştırılmış mı gönderildiği/talep edildiği bilgisi. Belge gönderim ve belge okuma servislerinde gönderilen değere göre işlem yapılmaktadır.
`PERIOD`	`text`	Hayir	Kullanım sorgulanacak yıl/ay değeri girilir. Değer girilmediği zaman son 6 aylık kullanımlar dönülür. Format : 201812
`PRODUCT_TYPE`	`select`	Hayir	Kullanımı sorgulanmak istenen ürün bilgisi girilir. Alabileceği değerler : ALL, EFATURA, EARSIV, EIRSALIYE, ESMM, EMM, EMUTABAKAT, SMS ve MAIL.
`DIRECTION`	`select`	Evet	Kullanımı sorgulanmak istenen ürünün hangi yönde gönderildiği bilgisi girilir. Alabileceği değerler : ALL, INBOX ve OUTBOX.