Studie+

Henvendelse til IST når der er problemer i APIet

Ting at være opmærksom på, når der laves en supportsag

For at gøre fejlbehandlingen hurtigere vil vi gerne bede databehandlere og andre brugere af studieplus APIet om at være mere grundige, når der indmeldes fejl eller problemer. Det gør behandlingen hos os langt lettere og hurtigere for jer. Nedenfor er der lavet en oversigt over, hvilke data, der skal med, når I indberetter en fejl til konsulentafdelingen. Hvis felterne ikke er med i første omgang vil det typisk betyde, at vi skal have taget kontakt til jer igen for at få dette uddybet.

Struktur for henvendelse af problemer I Studieplus APIet 

  1. Hvilken skole, defineret med instnr, vedrører denne henvendelse? 
    1. Eksempel “123465”, og fremgår altid af URL til API kaldet. 
  2. Hvilket client id anvendes til at foretage API kaldet fra? 
    1. Eksempel “ist.api-klient.123465” 
  3. Hvilket request uuid kan knyttes fejlen? 
    1. Alle svar fra API indeholder denne header (X-Uddata-Api-Request-Uuid) med en uuid værdi, der gør det muligt at finde kaldet I vores logs. 
  4. Hvilken URL kaldes der I APIet? 
    1. Eksempel: https://api.ist.com/production/uddataplus/institutions/123465/release_x/elever?_limit=1000
  5. Kan problemet genskabes på release_x eller release_y? 
    1. Eksempel: “Problemet findes kun på release_x” 
  6. Kort overskrift af problem.  
    1. Eksempel: “Der mangler elever I json” 
  7. Længere Beskrivelse:
    1. Eksempel: “Vi har fundet ud af, at der mangler elever I kaldet siden vi overgik fra Y til X I fredags. Vi kan køre videre på release_y uden problemer. Det lader til, at der mangler 2 elever I kaldet, når vi kalder release_x. De to elever har indi_id 123456 og 654321. Hvorfor er eleverne med I release_y og ikke i release_x?”