स्टॉक में नंबर वाले अमेरिकी राज्यों या कनाडाई प्रांतों की सूची प्राप्त करें

संयुक्त राज्य अमेरिका या कनाडा के लिए इस वैकल्पिक चरण का उपयोग करके खोज को राज्य या प्रांत तक सीमित करें। केवल US और CA स्वीकार किए जाते हैं।

• हर प्रविष्टि अनुरोध के समय उस राज्य के स्टॉक वाले प्रीफ़िक्स का विवरण देती है।
• इस लिंक का उपयोग करें: next_function। इससे उस राज्य के क्षेत्रों की सूची मिलती है। इसमें पहले से यह फ़िल्टर शामिल है: state; लेकिन यह शामिल नहीं है: pid।
• क्षेत्रों की खोज में राज्य की जानकारी का मिलान थोड़ा अलग ढंग से किया जाता है। यदि किसी राज्य का next_function यह परिणाम लौटाता है: No areas found, तो इसके बजाय यह कॉल करें: getareas और राज्य न दें।
• पहले इसकी जाँच करें: status.code; उसके बाद इसे पढ़ें: response। असमर्थित देश या ऐसा देश जिसके लिए कोई मेल खाता स्टॉक नहीं है, यह कोड लौटाता है: 404; इसके अनुरूप HTTP स्थिति नहीं लौटाई जाती।
• खाली सूची के साथ कोड 200 मिलने का अर्थ है कि स्टॉक मौजूद है, लेकिन उसमें राज्य की जानकारी नहीं है। यह कॉल करें: getareas और राज्य न दें।

अनुरोध

आवश्यक: HTTP Basic या Bearer टोकन (प्रमाणीकरण और API प्रतिक्रियाएँ देखें)। प्रमाणीकरण विफल होने पर खोज चलने से पहले HTTP 401 लौटाया जाता है।

GET अनुरोध में isocode पथ में दिया जाता है। यदि पथ का वह खंड छोड़ दिया जाए, तो इसके बजाय फ़ॉर्म-एन्कोड किया गया isocode फ़ील्ड पढ़ा जाता है। वैकल्पिक pid क्वेरी स्ट्रिंग में भेजा जाता है।

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getstates/US'

प्रतिक्रिया

मानक प्रतिक्रिया आवरण। सफलता पर status.code का मान 200 होता है, status.msg खाली होता है और status.results प्रविष्टियों की संख्या होती है। response एक सूची है, जिसे पहले name के अनुसार (बड़े और छोटे अक्षरों में अंतर किए बिना), फिर state कोड के अनुसार क्रमबद्ध किया जाता है। फ़ील्ड: state (प्रीफ़िक्स के राज्य संबंधी डेटा से लिया गया राज्य या प्रांत का कोड, सामान्यतः दो अक्षरों का; असामान्य मान बिना बदलाव के दिए जाते हैं); name (कैटलॉग में दिया गया नाम, या कैटलॉग में उसका नाम न होने पर कोड); country_iso; available (गिने गए सभी प्रीफ़िक्स का कुल स्टॉक, जो हमेशा 0 से अधिक होता है); prefix_count (गिने गए स्टॉक वाले प्रीफ़िक्स की संख्या); is_mobile (यदि कोई भी गिना गया प्रीफ़िक्स मोबाइल सेवा का समर्थन करता है तो 1; US के लिए हमेशा 0, जब तक आपके खाते में अमेरिकी मोबाइल नंबर सक्षम न हों); sms_coverage (यदि किसी भी गिने गए प्रीफ़िक्स में SMS कवरेज है तो 1); returns_numbers (यदि किसी भी गिने गए प्रीफ़िक्स पर नंबर लौटाने वाला फ़्लैग है या उस फ़्लैग का कोई मान नहीं है तो 1); next_function ('v3/getareas/{isocode}?state={state}')। यदि स्टॉक वाले प्रीफ़िक्स मौजूद हैं, लेकिन किसी में भी राज्य की जानकारी नहीं है, तो परिणाम में status.code का मान 200, सूची खाली और status.results का मान 0 होता है।

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 2
  },
  "response": [
    {
      "state": "NY",
      "name": "New York",
      "country_iso": "US",
      "available": 120,
      "prefix_count": 8,
      "is_mobile": 0,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=NY"
    },
    {
      "state": "TX",
      "name": "Texas",
      "country_iso": "US",
      "available": 45,
      "prefix_count": 3,
      "is_mobile": 0,
      "sms_coverage": 0,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=TX"
    }
  ]
}

त्रुटियाँ

• 500: msg 'ISO Code parameter is required': isocode मौजूद नहीं है या खाली है। यह अनुरोध की ऐसी त्रुटि है जिसे सुधारा जा सकता है। इसके अनुरूप HTTP स्थिति सेट नहीं की जाती; status.code पढ़ें।
• 404: msg 'getstates is only available for US and CA': कोई अन्य देश कोड दिया गया है। इसके अनुरूप HTTP स्थिति सेट नहीं की जाती।
• 404: msg 'No states found': देश और स्रोत के फ़िल्टर से मेल खाने वाला कोई स्टॉक वाला प्रीफ़िक्स नहीं है। इसके अनुरूप HTTP स्थिति सेट नहीं की जाती।
• 401: प्रमाणीकरण मौजूद नहीं है या विफल हो गया है। HTTP स्थिति 401 के साथ भेजा जाता है।

उपलब्धता और अन्य प्रभाव

• केवल जानकारी खोजता है। यह कोई आरक्षण, ऑर्डर या बदलाव नहीं करता। available केवल जानकारी देने के लिए है और नंबरों को रोककर नहीं रखता।