Valsts pārklājuma apgabalu saraksts

Pēc valsts izvēles (un ASV vai Kanādas gadījumā arī pēc neobligātas štata vai provinces izvēles no getstates), izsauciet getareas, lai redzētu, kur tiek piedāvāti numuri. Saglabājiet apgabala uuid nākamajam solim.

Katram apgabalam ir viens no diviem turpmākajiem soļiem:

• available > 0: next_function vērtība ir v3/getprefixes/{uuid}, kam tiek pievienots ?state=, ja izmantojāt štata vai provinces filtru. Izmantojiet to prefiksu pārlūkošanai.
• available = 0: apgabalam ir prefiksi, bet nav pieejamu numuru, un next_function vērtība ir v3/order/{uuid}. Šī soļa prasības skatiet pasūtīšanas dokumentācijā.

available ir kopējais pieejamo numuru skaits visā apgabalā arī tad, ja izmantojat štata vai provinces filtru. Šis filtrs pieņem kodu vai pilnu nosaukumu, taču darbojas tikai US un CA gadījumā. Ja štata vai provinces filtrs atgriež No areas found, mēģiniet vēlreiz bez šī filtra. Pārbaudes tiek veiktas šādā secībā: trūkst valsts koda, nezināma valsts, štata vai provinces filtrs citai valstij, nederīgs štats vai province, nav atbilstošu apgabalu. Katrā no šiem gadījumiem tiek atgriezts kods 500 vai 404 laukā status.code, nenosakot atbilstošu HTTP statusu.

Pieprasījums

Nepieciešama HTTP Basic autentifikācija vai Bearer pilnvara (skatiet sadaļu par autentifikāciju un API atbildēm). Ja autentifikācija neizdodas, pirms meklēšanas izpildes tiek atgriezta atbilde ar HTTP 401.

GET pieprasījums ar isocode ceļā un neobligātajiem parametriem state un pid vaicājuma virknē. Ja ceļa segments ir izlaists, tā vietā tiek nolasīts veidlapas kodējumā nosūtītais lauks isocode.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getareas/US'
curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getareas/US?state=NY'

Atbilde

Standarta atbildes ietvars. Veiksmīga pieprasījuma gadījumā status.code ir 200, status.msg ir 'Results: N', status.results ir N, un response ir saraksts, kas sakārtots pēc apgabala nosaukuma. Lauki: uuid (apgabala identifikators bez interpretējamas iekšējās struktūras, ko izmanto nākamajā solī); country_uuid (32 rakstzīmju valsts identifikators bez interpretējamas iekšējās struktūras, kas vēlāk nav nepieciešams); name; area_type un number_type (kataloga aprakstošie lauki; ieraksti ne vienmēr attiecas uz vietējo numuru tipiem); country_iso; is_mobile (0 vai 1, iegūts no apgabala mobilo numuru karodziņiem; US gadījumā vienmēr 0, ja vien jūsu kontā nav iespējoti US mobilie numuri); available (kopējais pieejamo numuru skaits visos atbilstošajos apgabala prefiksos, neierobežojot to līdz pieprasītajam štatam vai provincei); sms_coverage (0 vai 1); returns_numbers (0 vai 1, lielākā karodziņa vērtība starp apgabala prefiksiem); latitude un longitude; state_iso; next_function. state_iso: ja izmantots štata vai provinces filtrs, tas ir filtram noteiktais kods. US un CA gadījumā bez filtra tas ir štata vai provinces kods, ja tā nosaukums sakrīt ar apgabala nosaukumu; pretējā gadījumā tā ir apgabalam saglabātā vērtība, bet, ja arī tās nav, kods, kas iegūts no apgabala prefiksu datiem. Citām valstīm tā ir saglabātā vērtība, un tā var būt tukša. next_function ir 'v3/getprefixes/{uuid}' (ar pievienotu '?state={code}', ja izmantots filtrs), ja available ir lielāks par 0; pretējā gadījumā tas ir 'v3/order/{uuid}'. Apgabali, kuriem nav neviena atbilstoša prefiksa, netiek iekļauti. Apgabali ar prefiksiem, bet bez pieejamiem numuriem tiek atgriezti ar available vērtību 0.

Atbildes struktūras piemērs; tie nav faktiskie konta dati vai aktuāls cenas piedāvājums.

{
  "status": {
    "code": 200,
    "msg": "Results: 2",
    "results": 2
  },
  "response": [
    {
      "uuid": "0000000000000000000000000000a001",
      "country_uuid": "0000000000000000000000000000c001",
      "name": "Example City",
      "area_type": "City",
      "number_type": "Local",
      "country_iso": "US",
      "is_mobile": 0,
      "available": 58,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "latitude": "40.0000",
      "longitude": "-75.0000",
      "state_iso": "NY",
      "next_function": "v3/getprefixes/0000000000000000000000000000a001"
    },
    {
      "uuid": "0000000000000000000000000000a002",
      "country_uuid": "0000000000000000000000000000c001",
      "name": "Sample Town",
      "area_type": "City",
      "number_type": "Local",
      "country_iso": "US",
      "is_mobile": 0,
      "available": 0,
      "sms_coverage": 0,
      "returns_numbers": 0,
      "latitude": "41.0000",
      "longitude": "-76.0000",
      "state_iso": "PA",
      "next_function": "v3/order/0000000000000000000000000000a002"
    }
  ]
}

Kļūdas

• 500: msg 'ISO Code parameter is required': isocode nav norādīts vai ir tukšs. Tā ir labojama pieprasījuma kļūda. Atbilstošs HTTP statuss netiek noteikts.
• 404: msg 'Error: no such country': valsts kods nav zināms. Atbilstošs HTTP statuss netiek noteikts.
• 404: msg 'State filter is only available for US and CA': citai valstij ir nosūtīta netukša state vērtība. Atbilstošs HTTP statuss netiek noteikts.
• 404: msg 'Invalid state': state nav ne šai valstij zināms štata vai provinces kods, ne nosaukums. Atbilstošs HTTP statuss netiek noteikts.
• 404: msg 'No areas found': neviens apgabals neatbilst valsts, avota un štata vai provinces filtriem. Atbilstošs HTTP statuss netiek noteikts.
• 401: autentifikācija nav nodrošināta vai nav izdevusies. Tiek nosūtīts ar HTTP statusu 401.

Pieejamība un blakusefekti

• Tikai informācijas meklēšana klientu kontiem. Tā neko nerezervē, nepasūta un nemaina.
• available ir informatīva vērtība, un tā var mainīties pirms nākamā soļa.