Programiści

GET/v3/get_supporting_document_templates/{iso}

Lista szablonów dokumentów uzupełniających

Znajdź identyfikatory i nazwy szablonów oraz wskazówki dotyczące kraju przed przygotowaniem dokumentu uzupełniającego.

Na tej stronie
  1. Przeglądaj katalog szablonów
  2. Wybierz szablon na podstawie wymagań
  3. Jeśli nie zostaną zwrócone żadne szablony
  4. Sprawdź pobraną kopię przed jej użyciem
  5. Żądanie
  6. Odpowiedź
  7. Błędy
  8. Dostępność i skutki uboczne

Przeglądaj katalog szablonów

Pomiń opcjonalny segment ścieżki ISO, aby wyświetlić listę szablonów zwracanych przez usługę. Podaj kod ISO kraju, aby przefiltrować listę. Filtr dopasowuje wskazówkę dotyczącą kraju szablonu, która może być wywnioskowana z nazwy i może być pusta.

Wybierz szablon na podstawie wymagań

Obecność szablonu nie oznacza, że jest on wymagany lub akceptowany dla każdego numeru w danym kraju. Dopasuj identyfikator szablonu do obowiązujących wymagań dotyczących dokumentów uzupełniających. Ta lista nie generuje, nie podpisuje, nie przesyła ani nie zatwierdza wypełnionego dokumentu.

Jeśli nie zostaną zwrócone żadne szablony

Pusta przefiltrowana lista może oznaczać, że nie znaleziono pasującej wskazówki dotyczącej kraju. Pusta lista bez filtrowania może również wynikać z niedostępności danych w systemie źródłowym. Nie traktuj żadnego z tych wyników jako dowodu, że dokument uzupełniający nie jest wymagany.

Sprawdź pobraną kopię przed jej użyciem

Link do pobrania w katalogu może zwrócić kopię ze zmianami formatowania lub oznaczeń marki. Nie zakładaj, że jest to niezmieniona oryginalna umowa ani że jej pobranie spełnia wymóg rejestracji. Zapoznaj się z treścią przed wypełnieniem lub podpisaniem jakiegokolwiek dokumentu.

Jeśli kreator dokumentów w portalu umożliwia przygotowanie umowy, skorzystaj z podglądu i procesu wymagającego jawnego przesłania dokumentu. W przypadku innych wymaganych formularzy potwierdź aktualną wersję formularza z MultiTEL przed jego wypełnieniem. Pobrany szablon nie jest podpisanym załącznikiem, przesłanym dokumentem potwierdzającym ani zatwierdzeniem numeru.

Żądanie

Używaj danych uwierzytelniających aktywnego konta API przez HTTPS. Obsługiwane są uwierzytelnianie Basic oraz aktywne tokeny bearer konta API; obowiązują ograniczenia konta.

GET z dowolnym udokumentowanym parametrem w ścieżce adresu 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 ścieżki
NazwaTypWymaganyOpis
isostringNieOpcjonalny filtr kodu ISO kraju. Pomiń cały ten segment ścieżki, aby uzyskać listę bez filtrowania. Porównanie nie uwzględnia wielkości liter. Nieznane wartości lub wartości bez dopasowania powodują zwrócenie pustej listy zamiast jawnego błędu nieprawidłowego kraju.

Odpowiedź

Sprawdź status.code w treści JSON oraz status HTTP. response to tablica obiektów z polami id, name, permanent, iso i url. permanent ma typ boolean; iso może być puste i mogło zostać wywnioskowane z nazwy szablonu. Traktuj informacje o kraju jako wskazówkę, a nie decyzję o spełnieniu warunków. Pusty katalog jest pomyślną odpowiedzią 200 i może również wystąpić, gdy wyszukiwanie w systemie źródłowym nie zwróci danych. Adres URL jest generowany przez usługę; jego nazwa hosta może różnić się od podanej w przykładzie.

Przykładowa struktura odpowiedzi; nie są to rzeczywiste dane konta ani aktualna wycena.

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

Błędy

  • Sprawdź status.code i status.msg pod kątem błędów uwierzytelniania lub usługi. Pomyślne zwrócenie pustego katalogu nie oznacza zatwierdzenia dokumentu ani zwolnienia z obowiązku rejestracji.

Dostępność i skutki uboczne

  • To wyszukiwanie w katalogu lub wymaganiach nie tworzy tożsamości, nie przesyła dokumentu potwierdzającego, nie rejestruje numeru ani nie składa zamówienia.
  • Pomyślna odpowiedź katalogu nie oznacza zatwierdzenia Twoich dokumentów ani potwierdzenia, że wybrany numer może zostać aktywowany.