İzin Hareketi Sorgulama (Pull)

Bu metot, hizmet sağlaycının İYS'ye ilettiği veya bilgisi dışında alıcı tarafından İYS üzerinde gerçekleştirilen izin hareketlerini sorgulamayı sağlar.

  • İsteğin gönderildiği andan itibaren son 1 saat hariç 7 gün içerisinde gerçekleşen izin hareketleri İYS'ye kayıt tarihine (creationDate) göre sıralı olarak listelenir.
  • Önemli Not: Metodun path-param çalışma prensibi gereği kendi tarafınızca eklenen izinlerin hareketlerini API yoluyla çağırabilmek için istek yolunun sonu changes?source=HS şeklinde verilmelidir.

  • İYS yolu kullanılarak alıcıların kendi yaptıkları izin değişimlerini API yoluyla çağırabilme fonksiyonu (changes?source=IYS) henüz yayına alınmadığı için bu isteklere boş cevap dönülmektedir.

  • GET /sps/{iysCode}/brands/{brandCode}/consents/changes

  • İstek Cevabı: 200

Alan/Değer Açıklama
after İzin hareketlerindeki değişikliğin gösterildiği son nesneyi adresleyen işlem bilgisi
list Hareket gerçekleşen izinlerin bilgisi
consentDate İznin vatandaştan alındığı tarih ve saat
creationDate İznin İYS'ye kaydedilme tarihi
source İzin kaynağı
recipient Alıcının iletişim adresi
recipientType Alıcı tipi
status İzin durumu
type Alıcının izin verdiği iletişim kanalı
transactionId İYS'de gerçekleşen her bir izin hareketi için üretilen tekil işlem bilgisi
citizenName Alıcının ad soyad bilgisi
  • Not: citizenName Vatandaş uygulamaları aracılığıyla hizmet sağlayıcının markasına ilk defa izin erişimi ekleyen vatandaşa ait ad-soyad bilgisidir. Bu alan opsiyoneldir. Bu değerin gözükmesi için source=IYS olarak sorgulama isteği gönderilmeli ve sorgulanan markaya son 7 gün içerisinde bir vatandaşın ilk defa izin erişimi eklemiş olması gerekmektedir.
{
   "after":"1604423100000_053a37a1bd424b555c73d81a6954afd88664fb685f0f0f4d12b17206db381d2b",
   "list":[
      {
         "consentDate":"2015-05-01 00:00:00",
         "creationDate":"2020-11-02 11:32:58",
         "source":"HS_2015",
         "recipient":"+901111111111",
         "recipientType":"BIREYSEL",
         "status":"ONAY",
         "type":"MESAJ",
         "transactionId":"91c82ae4b5000b7cc7747f3b52265ea41f779171a10c52e98f09bd9595c33def"
      },
      {
         "consentDate":"2015-05-01 00:00:00",
         "creationDate":"2020-11-02 11:32:58",
         "source":"HS_2015",
         "recipient":"+902222222222",
         "recipientType":"BIREYSEL",
         "status":"ONAY",
         "type":"MESAJ",
         "transactionId":"a6f768ffc81bc705a99284497894863647933bd683fbe1fe55e6ad346aabbd94"
      },
      {
         "consentDate":"2020-11-01 11:35:15",
         "creationDate":"2020-11-02 11:36:27",
         "source":"HS_FIZIKSEL_ORTAM",
         "recipient":"+903333333333",
         "recipientType":"BIREYSEL",
         "status":"ONAY",
         "type":"ARAMA",
         "transactionId":"7a4409900453b1c78a9dc6151a6a770ef028c6ac8f44228c5ac7f30d219c43f7"
      }
   ]
}
  • Path-param yapısına uygun olmayacak şekilde bir parametre verilerek istek gönderildiğinde API cevabı şu şekildedir.

  • GET https://api.iys.org.tr/sps/{iysCode}/brands/{brandCode}/consents/changes?source=HSS

  • İstek Cevabı: 422

Alan/Değer Açıklama
errors Hatalı izni adresleyen obje
code Hata kodu
location Hatanın izin nesnesindeki yeri
message Hata koduna karşılık gelen mesaj 
{
  "errors": [
    {
      "code": "H506",
      "location": [
        "source"
      ],
      "message": "HSS kabul edilemedi. İstek gövdesinde bulunabilecek değerler: IYS, HS"
    }
  ]
}