Vývojáři

GET/v3/get_supporting_document_templates/{iso}

Seznam šablon podpůrných dokumentů

Před přípravou podpůrného dokumentu vyhledejte ID a názvy šablon a orientační údaje o zemi.

Na této stránce
  1. Procházení katalogu šablon
  2. Výběr šablony podle požadavků
  3. Pokud nejsou vráceny žádné šablony
  4. Před použitím zkontrolujte staženou kopii
  5. Požadavek
  6. Odpověď
  7. Chyby
  8. Dostupnost a vedlejší účinky

Procházení katalogu šablon

Chcete-li vypsat šablony vrácené službou, vynechte volitelný segment cesty s kódem ISO. Chcete-li seznam filtrovat, zadejte kód ISO země. Filtr porovnává orientační údaj o zemi u šablony, který může být odvozen z názvu a může být prázdný.

Výběr šablony podle požadavků

Přítomnost šablony neznamená, že je vyžadována nebo přijímána pro každé číslo v dané zemi. Porovnejte ID šablony s příslušnými požadavky na podpůrné dokumenty. Tento seznam nevytváří, nepodepisuje, nenahrává ani neschvaluje vyplněný dokument.

Pokud nejsou vráceny žádné šablony

Prázdný filtrovaný seznam může znamenat, že nebyl nalezen odpovídající orientační údaj o zemi. Prázdný nefiltrovaný seznam může také znamenat, že data z nadřazeného zdroje nejsou dostupná. Ani jeden z těchto výsledků nepovažujte za důkaz, že není vyžadován žádný podpůrný dokument.

Před použitím zkontrolujte staženou kopii

Odkaz ke stažení v katalogu může vrátit kopii se změnami formátování nebo prvků firemní identity. Nepředpokládejte, že jde o nezměněnou původní smlouvu ani že jejím stažením splníte požadavek registrace. Před vyplněním nebo podepsáním jakéhokoli dokumentu zkontrolujte jeho obsah.

Pokud průvodce dokumenty na portálu nabízí přípravu smlouvy, využijte jeho náhled a postup s výslovným odesláním. U ostatních požadovaných formulářů si před jejich vyplněním ověřte u MultiTEL aktuální podobu formuláře. Stažená šablona není podepsanou přílohou, nahraným dokladem ani schválením čísla.

Požadavek

Použijte přihlašovací údaje svého povoleného účtu API prostřednictvím HTTPS. Podporováno je ověřování Basic a povolené tokeny bearer účtu API; platí omezení účtu.

GET s případným dokumentovaným parametrem v cestě URL.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"
Parametry cesty
NázevTypPovinnýPopis
isostringNeVolitelný filtr podle kódu ISO země. Pro nefiltrovaný seznam vynechte celý tento segment cesty. Při porovnávání se nerozlišují velká a malá písmena. Neznámé hodnoty nebo hodnoty bez shody vracejí prázdný seznam místo výslovné chyby neplatné země.

Odpověď

Zkontrolujte status.code v těle JSON i stav HTTP. response je pole objektů s položkami id, name, permanent, iso a url. permanent je typu boolean; iso může být prázdné a může být odvozeno z názvu šablony. Údaje o zemi považujte za orientační informaci, nikoli za rozhodnutí o způsobilosti. Prázdný katalog představuje úspěšnou odpověď 200 a může se objevit také tehdy, když vyhledávání v nadřazeném zdroji nevrátí žádná data. URL generuje služba; název hostitele se může lišit od ilustrativního příkladu.

Ilustrativní struktura odpovědi; nejde o živá data účtu ani o aktuální cenovou nabídku.

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

Chyby

  • Chyby ověřování nebo služby zjistíte kontrolou status.code a status.msg. Úspěšná odpověď s prázdným katalogem neznamená schválení dokumentu ani výjimku z registrace.

Dostupnost a vedlejší účinky

  • Toto vyhledání katalogu či požadavků nevytváří identitu, nenahrává doklad, neregistruje číslo ani nezadává objednávku.
  • Úspěšná odpověď katalogu neznamená schválení vašich dokumentů ani potvrzení, že vybrané číslo lze aktivovat.