Lys Amerikaanse state of Kanadese provinsies met nommers in voorraad

Gebruik hierdie opsionele stap vir die Verenigde State of Kanada om die soektog tot 'n staat of provinsie te beperk. Slegs US en CA word aanvaar.

• Elke inskrywing beskryf die voorvoegsels met voorraad vir daardie staat ten tyde van die versoek.
• Volg next_function om die staat se gebiede te lys. Dit bevat reeds die state-filter, maar nie pid.
• Die gebiedsoektog bepaal ooreenkomste met staatinligting op 'n effens ander manier. As 'n staat se next_function die antwoord No areas found teruggee, roep eerder getareas sonder 'n staat aan.
• Kontroleer status.code voordat jy die volgende lees: response. 'n Land wat nie ondersteun word nie, of 'n land sonder ooreenstemmende voorraad, gee kode 404 terug sonder 'n ooreenstemmende HTTP-status.
• 'n Leë lys met kode 200 beteken dat voorraad bestaan, maar geen staatinligting bevat nie. Roep getareas sonder 'n staat aan.

Versoek

Vereis: HTTP Basic-verifikasie of 'n Bearer-token (sien Verifikasie en API-antwoorde). Mislukte verifikasie word met HTTP 401 beantwoord voordat die soektog uitgevoer word.

GET met isocode in die pad. As die padsegment weggelaat word, word 'n vormgekodeerde isocode-veld eerder gelees. Die opsionele pid word in die navraagstring gestuur.

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

Antwoord

Standaard antwoordomhulsel. By sukses is status.code 200, is status.msg leeg en is status.results die aantal inskrywings. response is 'n lys wat volgens name gesorteer is (sonder onderskeid tussen hoof- en kleinletters), en daarna volgens die state-kode. Velde: state (staat- of provinsiekode uit die voorvoegsels se staatdata, gewoonlik twee letters; ongewone waardes word onveranderd deurgegee); name (katalogusnaam, of die kode as die katalogus geen naam daarvoor het nie); country_iso; available (totale voorraad oor die getelde voorvoegsels, altyd groter as 0); prefix_count (aantal voorvoegsels met voorraad wat getel is); is_mobile (1 as enige getelde voorvoegsel mobiele diens ondersteun; altyd 0 vir US, tensy jou rekening vir Amerikaanse mobiele nommers geaktiveer is); sms_coverage (1 as enige getelde voorvoegsel SMS-dekking het); returns_numbers (1 as enige getelde voorvoegsel die vlag vir die teruggee van nommers het, of geen waarde daarvoor het nie); next_function ('v3/getareas/{isocode}?state={state}'). As voorvoegsels met voorraad bestaan, maar nie een staatinligting bevat nie, is die resultaat status.code met waarde 200, 'n leë lys en status.results met waarde 0.

Voorbeeld van die antwoordstruktuur; dit is nie lewendige rekeningdata of 'n huidige kwotasie nie.

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

Foute

• 500: msg 'ISO Code parameter is required': isocode ontbreek of is leeg. Dit is 'n versoekfout wat reggestel kan word. Geen ooreenstemmende HTTP-status word gestel nie; lees status.code.
• 404: msg 'getstates is only available for US and CA': enige ander landkode. Geen ooreenstemmende HTTP-status word gestel nie.
• 404: msg 'No states found': geen voorvoegsels met voorraad stem met die land- en bronfilters ooreen nie. Geen ooreenstemmende HTTP-status word gestel nie.
• 401: Verifikasie ontbreek of het misluk. Word met HTTP-status 401 gestuur.

Beskikbaarheid en newe-effekte

• Slegs 'n soektog. Dit reserveer, bestel of verander niks nie. available is slegs ter inligting en hou geen nommers terug nie.