Tekil İzin Ekleme

Bu metot, alıcıdan alınmış izinlerin tekil olarak İYS'ye yüklenmesine imkan tanır.

  • POST /sps/{iysCode}/brands/{brandCode}/consents
Alan/Değer Açıklama
consentDate İznin vatandaştan alındığı tarih ve saat
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ı
retailerCode İznin alınmasına aracılık eden bayinin İYS numarası
retailerAccess İzne erişimi olan bayilerin İYS numaraları
{
  "consentDate": "2018-02-10 09:30:00",
  "source": "HS_CAGRI_MERKEZI",
  "recipient": "+905813334455",
  "recipientType": "BIREYSEL",
  "status": "ONAY",
  "type": "ARAMA",
  "retailerCode": 11223344,
  "retailerAccess": [22233344, 44222419, 13239987]
}
  • Yukarıdaki örnekte yer alan retailerCode ve retailerAccess alanları bayi izin yönetimi yapılmadığı takdirde zorunlu değildir.
  • İznin alınmasına aracılık eden bayinin belirtilmesi ve farklı bayilere bu izne erişim vermek amacıyla, bu alanlara izin seti içerisinde opsiyonel olarak yer verilebilir.

  • İstek Cevabı: 200

Alan/Değer Açıklama
transactionId İzin yükleme isteğinin aktarım bilgisi
creationDate İznin İYS'ye yazıldığı tarih ve saat
{
  "transactionId": "73b75030-3a92-4f1e-b247-b0509dbadbfc",
  "creationDate": "2020-07-24 14:27:06"
}
  • İ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": [
        {
            "location": [
                "recipient"
            ],
            "code": "H114",
            "message": "Alıcı (recipient) bulunamadı."
        },
        {
            "location": [
                "source"
            ],
            "code": "H113",
            "message": "İzin kaynağı (source) bulunamadı."
        },
        {
            "location": [
                "type"
            ],
            "code": "H111",
            "message": "İzin tipi (type) bulunamadı."
        },
        {
            "location": [
                "consentDate"
            ],
            "code": "H112",
            "message": "İzin tarihi (consentDate) bulunamadı."
        },
        {
            "location": [
                "status"
            ],
            "code": "H110",
            "message": "Durum (status) bulunamadı."
        }
    ]
}
  • Hatalı İstek:
    {
        "consentDate": "2020-13-10 09:50:00",
        "source": "HS_CAGRI_MERKEZI_",
        "recipient": "+905357990074444",
        "recipientType": "BIREYSELL",
        "status": "ONAQT",
        "type": "ARAMAX",
    }
    
  • İstek Cevabı: 451
Alan/Değer Açıklama
errors Hatalı izni adresleyen obje
code Hata kodu
location Hatanın izin nesnesindeki yeri
value Hatalı değer
message Hata koduna karşılık gelen mesaj

Not: Hata şekil validasyonundan kaynaklı olursa 422, usul validasyonundan kaynaklı olursa 451 dönülür.

  
{
    "errors": [
        {
            "code": "H117",
            "location": [
                "type"
            ],
            "value": "ARAMAX",
            "message": "İzin tipi (type) için uygun değerler: ARAMA, MESAJ, EPOSTA"
        },
        {
            "code": "H115",
            "location": [
                "status"
            ],
            "value": "ONAQT",
            "message": "Durum (status) için uygun değerler: ONAY, RET"
        },
        {
            "code": "H119",
            "location": [
                "source"
            ],
            "value": "HS_CAGRI_MERKEZI_",
            "message": "İzin kaynağı (source) için uygun değerler: HS_FIZIKSEL_ORTAM, HS_ISLAK_IMZA, HS_WEB, HS_CAGRI_MERKEZI, HS_SOSYAL_MEDYA, HS_EPOSTA, HS_MESAJ, HS_MOBIL, HS_EORTAM, HS_ETKINLIK, HS_2015, HS_ATM"
        },
        {
            "code": "H116",
            "location": [
                "recipientType"
            ],
            "value": "BIREYSELL",
            "message": "Alıcı tipi (recipientType) için uygun değerler: BIREYSEL, TACIR"
        },
        {
            "code": "H157",
            "location": [
                "consentDate"
            ],
            "message": "İzin tarihi (consentDate) için geçerli bir tarih girilmelidir.",
            "value": "2020-13-10 09:50:00"
        },
        {
            "location": [
                "recipient"
            ],
            "value": "+905357990074444",
            "code": "H122",
            "message": "Alıcı (recipient) için E164 uluslararası ([+][country code][area code][local phone number]) formata uygun bir telefon numarası (örn. +905542200000) ya da geçerli bir e-posta adresi girilmelidir."
        }
    ]
}