डेवलपर

GET/v3/get_supporting_document_templates/{iso}

सहायक दस्तावेज़ों के टेम्पलेट की सूची देखें

सहायक दस्तावेज़ तैयार करने से पहले टेम्पलेट की आईडी, नाम और देश संबंधी संकेत खोजें।

इस पृष्ठ पर
  1. टेम्पलेट की सूची देखें
  2. आवश्यकताओं के अनुसार टेम्पलेट चुनें
  3. यदि कोई टेम्पलेट न लौटे
  4. डाउनलोड की गई प्रति का उपयोग करने से पहले उसकी समीक्षा करें
  5. अनुरोध
  6. प्रतिक्रिया
  7. त्रुटियाँ
  8. उपलब्धता और अतिरिक्त प्रभाव

टेम्पलेट की सूची देखें

सेवा से लौटाए गए टेम्पलेट की सूची देखने के लिए वैकल्पिक ISO पथ खंड छोड़ दें। सूची को फ़िल्टर करने के लिए देश का ISO कोड दें। फ़िल्टर टेम्पलेट के देश संबंधी संकेत से मिलान करता है; यह संकेत नाम से अनुमानित हो सकता है और खाली भी हो सकता है।

आवश्यकताओं के अनुसार टेम्पलेट चुनें

किसी टेम्पलेट के मौजूद होने का अर्थ यह नहीं है कि वह उस देश के हर नंबर के लिए आवश्यक या स्वीकार्य है। टेम्पलेट की आईडी का मिलान सहायक दस्तावेज़ों की लागू आवश्यकताओं से करें। यह सूची भरा हुआ दस्तावेज़ तैयार नहीं करती, उस पर हस्ताक्षर नहीं करती, उसे अपलोड नहीं करती और न ही उसे मंज़ूरी देती है।

यदि कोई टेम्पलेट न लौटे

फ़िल्टर की गई सूची खाली होने का अर्थ हो सकता है कि देश संबंधी कोई मेल खाता संकेत नहीं मिला। बिना फ़िल्टर की सूची खाली होना अपस्ट्रीम स्रोत से डेटा उपलब्ध न होने के कारण भी हो सकता है। इनमें से किसी भी परिणाम को इस बात का प्रमाण न मानें कि किसी सहायक दस्तावेज़ की आवश्यकता नहीं है।

डाउनलोड की गई प्रति का उपयोग करने से पहले उसकी समीक्षा करें

सूची में दिया गया डाउनलोड लिंक ऐसी प्रति लौटा सकता है जिसके प्रारूप या ब्रांडिंग में बदलाव किए गए हों। यह न मानें कि वह बिना किसी बदलाव वाला मूल अनुबंध है या उसे डाउनलोड करने से पंजीकरण की कोई आवश्यकता पूरी हो जाती है। किसी भी दस्तावेज़ को भरने या उस पर हस्ताक्षर करने से पहले उसकी सामग्री की समीक्षा करें।

जहाँ पोर्टल का दस्तावेज़ विज़ार्ड अनुबंध तैयार करने की सुविधा देता है, वहाँ उसके पूर्वावलोकन और स्पष्ट रूप से सबमिट करने की कार्यप्रक्रिया का उपयोग करें। अन्य आवश्यक फ़ॉर्म भरने से पहले MultiTEL से वर्तमान फ़ॉर्म की पुष्टि कर लें। डाउनलोड किया गया टेम्पलेट न तो हस्ताक्षरित संलग्नक है, न अपलोड किया गया प्रमाण और न ही किसी नंबर की मंज़ूरी।

अनुरोध

HTTPS पर अपने सक्षम API खाते के क्रेडेंशियल का उपयोग करें। Basic प्रमाणीकरण और सक्षम API खाते के bearer टोकन समर्थित हैं; खाते के प्रतिबंध लागू होते हैं।

GET अनुरोध में दस्तावेज़ में बताए गए किसी भी पैरामीटर को URL पथ में दें।

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"
पथ पैरामीटर
नामप्रकारआवश्यकविवरण
isostringनहींदेश के ISO कोड का वैकल्पिक फ़िल्टर। बिना फ़िल्टर की सूची के लिए यह पूरा पथ खंड छोड़ दें। तुलना में बड़े और छोटे अक्षरों का अंतर नहीं माना जाता। अज्ञात या मेल न खाने वाले मानों पर देश अमान्य होने की स्पष्ट त्रुटि के बजाय खाली सूची लौटती है।

प्रतिक्रिया

HTTP स्थिति के साथ-साथ JSON बॉडी में status.code भी जाँचें। response उन ऑब्जेक्ट की सरणी है जिनमें id, name, permanent, iso और url होते हैं। permanent का प्रकार boolean है; iso खाली हो सकता है और उसका अनुमान टेम्पलेट के नाम से लगाया गया हो सकता है। देश की जानकारी को संकेत मानें, पात्रता का निर्णय नहीं। खाली सूची एक सफल 200 प्रतिक्रिया है और अपस्ट्रीम स्रोत में खोज से कोई डेटा न मिलने पर भी ऐसा परिणाम आ सकता है। URL सेवा द्वारा बनाया जाता है; उसका होस्टनाम उदाहरण में दिए गए होस्टनाम से अलग हो सकता है।

प्रतिक्रिया की संरचना का उदाहरण; यह खाते का वास्तविक समय का डेटा या वर्तमान मूल्य प्रस्ताव नहीं है।

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "TEMPLATE_ID_FROM_RESPONSE",
      "name": "Example supporting-document template",
      "permanent": false,
      "iso": "US",
      "url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
    }
  ]
}

त्रुटियाँ

  • प्रमाणीकरण या सेवा संबंधी त्रुटियों के लिए status.code और status.msg जाँचें। सफल प्रतिक्रिया में खाली सूची मिलना किसी दस्तावेज़ की मंज़ूरी या पंजीकरण से छूट नहीं है।

उपलब्धता और अतिरिक्त प्रभाव

  • सूची या आवश्यकताओं की यह खोज कोई पहचान नहीं बनाती, कोई प्रमाण अपलोड नहीं करती, कोई नंबर पंजीकृत नहीं करती और न ही कोई ऑर्डर देती है।
  • सूची की सफल प्रतिक्रिया आपके दस्तावेज़ों की मंज़ूरी या इस बात की पुष्टि नहीं है कि चुना गया नंबर सक्रिय किया जा सकता है।