Listoni shtetet e SHBA-së ose provincat kanadeze me numra në stok

Përdoreni këtë hap opsional për Shtetet e Bashkuara ose Kanadanë për ta kufizuar kërkimin sipas shtetit ose provincës. Pranohen vetëm US dhe CA.

• Çdo zë përshkruan prefikset në stok për atë shtet në çastin e kërkesës.
• Ndiqni next_function për të listuar zonat e shtetit. Lidhja tashmë përfshin filtrin state, por jo pid.
• Kërkimi i zonave e përputh informacionin e shtetit në një mënyrë paksa të ndryshme. Nëse, për një shtet, next_function kthen No areas found, thirrni getareas pa përcaktuar një shtet.
• Kontrolloni status.code përpara se të lexoni response. Një vend që nuk mbështetet ose një vend pa stok që përputhet kthen kodin 404 pa një status HTTP përkatës.
• Një listë bosh me kodin 200 do të thotë se ka stok, por ai nuk përmban informacion për shtetin. Thirrni getareas pa përcaktuar një shtet.

Kërkesa

Kërkohet: autentikim HTTP Basic ose token Bearer (shihni Autentikimi dhe përgjigjet e API-së). Kur autentikimi dështon, jepet përgjigjja HTTP 401 përpara se të kryhet kërkimi.

GET me isocode në shteg. Nëse segmenti i shtegut lihet jashtë, në vend të tij lexohet fusha isocode e koduar si të dhëna formulari. Parametri opsional pid dërgohet në vargun e parametrave të kërkimit.

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

Përgjigjja

Strukturë standarde e përgjigjes. Në rast suksesi, status.code është 200, status.msg është bosh dhe status.results është numri i zërave. response është një listë e renditur sipas name (pa dallim mes shkronjave të mëdha dhe të vogla), pastaj sipas kodit state. Fushat: state (kodi i shtetit ose i provincës, i marrë nga të dhënat e prefikseve për shtetin, zakonisht me dy shkronja; vlerat e pazakonta përcillen të pandryshuara); name (emri në katalog ose kodi kur katalogu nuk ka një emër për të); country_iso; available (stoku i përgjithshëm për prefikset e numëruara, gjithmonë më i madh se 0); prefix_count (numri i prefikseve në stok që janë numëruar); is_mobile (1 nëse të paktën një prefiks i numëruar mbështet telefoninë celulare; gjithmonë 0 për US, përveç rasteve kur llogaria juaj është aktivizuar për numra celularë të SHBA-së); sms_coverage (1 nëse të paktën një prefiks i numëruar ka mbulim SMS); returns_numbers (1 nëse të paktën një prefiks i numëruar ka të aktivizuar treguesin e kthimit të numrave ose nuk ka vlerë për të); next_function ('v3/getareas/{isocode}?state={state}'). Nëse ka prefikse në stok, por asnjëri nuk përmban informacion për shtetin, rezultati është status.code 200 me një listë bosh dhe status.results 0.

Strukturë ilustruese e përgjigjes; nuk përfaqëson të dhëna të llogarisë në kohë reale ose një ofertë çmimi aktuale.

{
  "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"
    }
  ]
}

Gabimet

• 500: msg 'ISO Code parameter is required': isocode mungon ose është bosh. Ky është një gabim i kërkesës që mund të korrigjohet. Nuk caktohet një status HTTP përkatës; lexoni status.code.
• 404: msg 'getstates is only available for US and CA': çdo kod tjetër vendi. Nuk caktohet një status HTTP përkatës.
• 404: msg 'No states found': asnjë prefiks në stok nuk përputhet me filtrat e vendit dhe të burimit. Nuk caktohet një status HTTP përkatës.
• 401: Autentikimi mungon ose ka dështuar. Dërgohet me statusin HTTP 401.

Disponueshmëria dhe efektet anësore

• Vetëm kërkim. Nuk rezervon, nuk porosit dhe nuk ndryshon asgjë. available shërben për informacion dhe nuk mban numra të rezervuar.