Dezvoltatori

GET/v3/get_supporting_document_templates/{iso}

Listați șabloanele pentru documente justificative

Găsiți ID-urile și denumirile șabloanelor, precum și indiciile privind țara, înainte de a pregăti un document justificativ.

Pe această pagină
  1. Consultați catalogul de șabloane
  2. Folosiți cerințele pentru a alege un șablon
  3. Dacă nu sunt returnate șabloane
  4. Verificați copia descărcată înainte de a o utiliza
  5. Cerere
  6. Răspuns
  7. Erori
  8. Disponibilitate și efecte secundare

Consultați catalogul de șabloane

Omiteți segmentul opțional ISO din cale pentru a lista șabloanele returnate de serviciu. Furnizați codul ISO al unei țări pentru a filtra lista. Filtrul caută potriviri cu indiciul privind țara șablonului, care poate fi dedus dintr-o denumire și poate fi gol.

Folosiți cerințele pentru a alege un șablon

Prezența unui șablon nu înseamnă că acesta este obligatoriu sau acceptat pentru fiecare număr din țara respectivă. Corelați ID-ul șablonului cu cerințele aplicabile privind documentele justificative. Această listă nu generează, nu semnează, nu încarcă și nu aprobă un document completat.

Dacă nu sunt returnate șabloane

O listă filtrată goală poate însemna că nu a fost găsit niciun indiciu corespunzător privind țara. O listă nefiltrată goală poate reflecta și indisponibilitatea datelor din sursa din amonte. Nu considerați niciunul dintre aceste rezultate drept dovadă că nu este necesar un document justificativ.

Verificați copia descărcată înainte de a o utiliza

Un link de descărcare din catalog poate returna o copie cu modificări de formatare sau ale elementelor de marcă. Nu presupuneți că aceasta este un acord original nemodificat sau că descărcarea sa îndeplinește o cerință de înregistrare. Verificați conținutul înainte de a completa sau semna orice document.

În cazul în care asistentul pentru documente din portal oferă pregătirea acordurilor, folosiți funcția sa de previzualizare și fluxul de trimitere explicită. Pentru celelalte formulare obligatorii, confirmați cu MultiTEL versiunea actuală a formularului înainte de a-l completa. Un șablon descărcat nu constituie un atașament semnat, o dovadă încărcată sau aprobarea unui număr.

Cerere

Folosiți datele de autentificare ale contului API activat, prin HTTPS. Sunt acceptate autentificarea Basic și tokenurile bearer activate pentru contul API; se aplică restricțiile contului.

GET cu orice parametru documentat în calea URL-ului.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"
Parametri de cale
DenumireTipObligatoriuDescriere
isostringNuFiltru opțional după codul ISO al țării. Omiteți acest segment de cale în întregime pentru a obține lista nefiltrată. Compararea nu ține cont de diferența dintre majuscule și minuscule. Valorile necunoscute sau fără potrivire returnează o listă goală în locul unei erori explicite de țară nevalidă.

Răspuns

Verificați status.code din corpul JSON, precum și starea HTTP. response este un tablou de obiecte cu câmpurile id, name, permanent, iso și url. permanent este de tip boolean; iso poate fi gol și poate să fi fost dedus din denumirea șablonului. Considerați informațiile despre țară drept un indiciu, nu o decizie de eligibilitate. Un catalog gol reprezintă un răspuns reușit cu codul 200 și poate apărea și atunci când interogarea sursei din amonte nu furnizează date. URL-ul este generat de serviciu; numele său de gazdă poate diferi de cel din exemplul ilustrativ.

Structură ilustrativă a răspunsului; nu reprezintă date în timp real ale contului sau o ofertă de preț actuală.

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

Erori

  • Verificați status.code și status.msg pentru erori de autentificare sau ale serviciului. Un catalog gol returnat cu succes nu constituie aprobarea unui document sau o scutire de la înregistrare.

Disponibilitate și efecte secundare

  • Această interogare a catalogului sau a cerințelor nu creează o identitate, nu încarcă o dovadă, nu înregistrează un număr și nu plasează o comandă.
  • Un răspuns reușit al catalogului nu constituie aprobarea documentelor dumneavoastră sau confirmarea că un număr selectat poate fi activat.