Ontwikkelaars

GET/v3/get_supporting_document_templates/{iso}

Sjablonen voor ondersteunende documenten opvragen

Zoek sjabloon-ID's, namen en landindicaties voordat u een ondersteunend document opstelt.

Op deze pagina
  1. Bekijk de sjablooncatalogus
  2. Kies een sjabloon aan de hand van de vereisten
  3. Als er geen sjablonen worden geretourneerd
  4. Controleer een gedownloade kopie voordat u deze gebruikt
  5. Verzoek
  6. Antwoord
  7. Fouten
  8. Beschikbaarheid en neveneffecten

Bekijk de sjablooncatalogus

Laat het optionele ISO-padsegment weg om de sjablonen op te vragen die de service retourneert. Geef de ISO-landcode op om de lijst te filteren. Het filter zoekt naar overeenkomsten met de landindicatie van het sjabloon, die uit een naam kan zijn afgeleid en leeg kan zijn.

Kies een sjabloon aan de hand van de vereisten

De aanwezigheid van een sjabloon betekent niet dat het vereist is of wordt geaccepteerd voor elk nummer in dat land. Stem het sjabloon-ID af op de toepasselijke vereisten voor ondersteunende documenten. Met deze lijst wordt geen ingevuld document gegenereerd, ondertekend, geüpload of goedgekeurd.

Als er geen sjablonen worden geretourneerd

Een lege gefilterde lijst kan betekenen dat er geen overeenkomende landindicatie is gevonden. Een lege ongefilterde lijst kan ook het gevolg zijn van niet-beschikbare gegevens uit een achterliggende bron. Beschouw geen van beide resultaten als bewijs dat er geen ondersteunend document vereist is.

Controleer een gedownloade kopie voordat u deze gebruikt

Een downloadlink in de catalogus kan een kopie opleveren waarvan de opmaak of huisstijl is gewijzigd. Ga er niet van uit dat dit een ongewijzigde originele overeenkomst is of dat u door deze te downloaden aan een registratievereiste voldoet. Controleer de inhoud voordat u een document invult of ondertekent.

Als de documentwizard in het portaal de mogelijkheid biedt om een overeenkomst op te stellen, gebruik dan de voorbeeldweergave en de procedure voor expliciete indiening. Controleer voor andere vereiste formulieren bij MultiTEL wat het actuele formulier is voordat u het invult. Een gedownload sjabloon is geen ondertekende bijlage, geüpload bewijsstuk of goedkeuring van een nummer.

Verzoek

Gebruik de inloggegevens van uw ingeschakelde API-account via HTTPS. Basic-authenticatie en ingeschakelde bearer-tokens voor API-accounts worden ondersteund; accountbeperkingen zijn van toepassing.

GET met een eventuele gedocumenteerde parameter in het URL-pad.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"
Padparameters
NaamTypeVerplichtBeschrijving
isostringNeeOptioneel filter op ISO-landcode. Laat dit volledige padsegment weg voor de ongefilterde lijst. Bij de vergelijking wordt geen onderscheid gemaakt tussen hoofdletters en kleine letters. Onbekende waarden of waarden zonder overeenkomst leveren een lege lijst op in plaats van een expliciete foutmelding voor een ongeldig land.

Antwoord

Controleer zowel status.code in de JSON-inhoud als de HTTP-status. response is een array van objecten met id, name, permanent, iso en url. permanent is een boolean; iso kan leeg zijn en kan zijn afgeleid van de sjabloonnaam. Beschouw landinformatie als een indicatie, niet als een beslissing over geschiktheid. Een lege catalogus is een geslaagd antwoord met status 200 en kan ook ontstaan wanneer de zoekopdracht in de achterliggende bron geen gegevens oplevert. De URL wordt door de service gegenereerd; de hostnaam kan afwijken van die in het illustratieve voorbeeld.

Illustratieve antwoordstructuur; geen actuele accountgegevens of actuele prijsopgave.

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

Fouten

  • Controleer status.code en status.msg op authenticatie- of servicefouten. Een geslaagd antwoord met een lege catalogus betekent geen goedkeuring van een document of vrijstelling van registratie.

Beschikbaarheid en neveneffecten

  • Met deze zoekopdracht naar catalogusgegevens of vereisten wordt geen identiteit aangemaakt, bewijsstuk geüpload, nummer geregistreerd of bestelling geplaatst.
  • Een geslaagd catalogusantwoord betekent niet dat uw documenten zijn goedgekeurd of dat is bevestigd dat een geselecteerd nummer kan worden geactiveerd.