API

Sådan bruger du DoCAS API

Introduktion


Hvis du er Maxi-kunde kan du bruge vores nye API. Du kan finde de forskellige nøgler du skal bruge, ved at gå ind under API-indstillinger på DoCAS.dk




Du kan nu se de 2 nøgler, du skal bruge.



Tilmeldings postback url kan du bruge, hvis du ønsker at kunderne skal føres tilbage til din egen hjemmeside efter endt tilmelding, i stedet for til vores offentlige kvitteringsside.

Metoder


Udbyder


For at hente information om din kursusudbyder, skal du bruge følgende URL:

docas.dk/api/vendor/{Read-Only API Key}/{Vendor ID}

Her er et eksempel fra udbyderen Bager- og Konditoriskolen:
docas.dk/api/vendor/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?format=jsonp

Her er et JQuery eksempel, på hvordan du kan bruge API'et på din egen hjemmeside:


// Her hentes information om udbyderen ud i en tabel med id="tabel"
$.getJSON("https://docas.dk/api/vendor/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?callback=?", function(result) {
 var id = "<tr><td>Id:</td><td>" + result.iD + "</td>";
 var navn = "<tr><td>Navn:</td><td>" + result.name + "</td>";
 var adresse = "<tr><td>Adresse:</td><td>" + result.address + ", " + result.zipCode + " " + result.city + "</td>";
 var telefon = "<tr><td>Telefon:</td><td>" + result.phone + "</td>";
 var email = "<tr><td>Email:</td><td>" + result.email + "</td>";
 var logourl = "<tr><td>Logo URL:</td><td>" + result.logoURL + "</td>";
 var www = "<tr><td>Webadresse:</td><td>" + result.wWW + "</td>";
 var cvr = "<tr><td>CVR:</td><td>" + result.cVR + "</td>";
 var ean = "<tr><td>EAN:</td><td>" + result.eAN + "</td>";
 var kontakt = "<tr><td>Kontaktperson:</td><td>" + result.contactPersonName + "</td>";
 var kontaktemail = "<tr><td>Kontaktemail:</td><td>" + result.contactPersonEmail + "</td>";
 var beskrivelse = "<tr><td>Beskrivelse:</td><td>" + result.description + "</td>";
$("#tabel").append(id + navn + adresse + telefon + email + logourl + www + cvr + ean + kontakt + kontaktemail + beskrivelse);
});
});

Kurser


For at få en liste over alle dine kurser, skal du bruge følgende URL:

docas.dk/api/courses/{Read-Only API Key}/{Vendor ID}

Her er et eksempel fra udbyderen Bager- og Konditoriskolen:
docas.dk/api/courses/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?format=jsonp

Du kan også hente data ud for et enkelt kursus. Her skal du bruge følgende URL:

docas.dk/api/course/{Read-Only API Key}/{Vendor ID}/{Kursus ID}

Kursus ID får du fra førnævnte liste. Et eksempel:
docas.dk/api/course/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f/2f72bb4a-2b1e-40d8-8176-a45000f43891?format=jsonp

Her er et JQuery eksempel, på hvordan du kan bruge API'et på din egen hjemmeside:


// Her henter vi en liste over alle kurser ud i en tabel med id="allekurser"
$(document).ready(function () {
$.getJSON("https://docas.dk/api/courses/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?callback=?", function (result) {
for (var i = 0; i < result.length; i++) {
  var navn = "<td>" + result[i].name + "</td>";
  var start = "<td>" + result[i].start + "</td>";
  var slut = "<td>" + result[i].end + "</td>";
  var underviser = "<td>" + result[i].instructorName + "</td>";
  var sted = "<td>" + result[i].locationName + "</td>";
  var lokale = "<td>" + result[i].locationRoom + "</td>";
  var pris = "<td>" + result[i].price + "</td>";
  var pladser = "<td>" + result[i].maxParticipants + "</td>";
  $("#allekurser").append("<tr>" + navn + start + slut + underviser + sted + lokale + pris
      + pladser + "</tr>");
}
});
 
// Her kan man se de informationer, man kan hente om et enkelt kursus            
$.getJSON("https://docas.dk/api/course/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f/2f72bb4a-2b1e-40d8-8176-a45000f43891?callback=?", function (result) {
 var iD = result.iD;
 var navn = result.name;
 var beskrivelse = result.description;
 var start = result.start;
 var slut = result.end;
 var tilmeldfrist = result.enrollmentDeadline;
 var afmeldfrist = result.usubscribeDeadline;
 var underviser = result.instructorName;
 var underviseremail = result.instructorEmail;
 var underviserid = result.instructorId;
 var sted = result.locationName;
 var stedid = result.locationId;
 var stedadresse = result.locationAddress + ", " + result.locationZipCode + " " 
   + result.locationCity;
 var stedemail = result.locationEmail;
 var lokale = result.locationRoom;
 var pris = result.price;
 var aktiv = result.active;
 var pladser = result.maxParticipants;
 var antaldeltagere = result.numberOfParticipants;
 var ledigepladser = result.availablePlaces;
 
 // bool der viser true eller false
 var harventeliste = result.allowsWaitingList;
 var antalpaaventeliste = result.peopleOnWaitingList;


 var skabelonid = result.courseModelId;
});
});

Skabeloner


For at få en liste over alle dine skabeloner, skal du bruge følgende URL:

docas.dk/api/coursemodels/{Read-Only API Key}/{Vendor ID}

Her er et eksempel fra udbyderen Bager- og Konditoriskolen:
docas.dk/api/coursemodels/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?format=jsonp

Du kan også hente data ud for en enkelt skabelon. Her skal du bruge følgende URL:

docas.dk/api/coursemodel/{Read-Only API Key}/{Vendor ID}/{Skabelon ID}

Skabelon ID får du fra førnævnte liste. Et eksempel:
docas.dk/api/coursemodel/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f/d11930cc-fbd9-434a-8411-ede6a1130f2d?format=jsonp

Her er et JQuery eksempel, på hvordan du kan bruge API'et på din egen hjemmeside:


// her henter vi en liste over skabeloner ud i en tabel med id="alleskabeloner"
$(document).ready(function () {
 $.getJSON("https://docas.dk/api/coursemodels/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?callback=?", function (result) {
 for (var i = 0; i < result.courseModels.length; i++) {
   var navn = "<td>" + result.courseModels[i].name + "</td>";
   var id = "<td>" + result.courseModels[i].iD + "</td>";
   $("#alleskabeloner").append("<tr>" + navn + id + "</tr>");
 }
});

// her gemmes informationerne om en enkelt skabelon i variabler
$.getJSON("https://docas.dk/api/coursemodel/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f/d11930cc-fbd9-434a-8411-ede6a1130f2d?callback=?", function(result) {
 var iD = result.iD;
 var navn = result.name;
 var beskrivelse = result.description;
 var start = result.start;
 var slut = result.end;
 var tilmeldfrist = result.enrollmentDeadline;
 var afmeldfrist = result.usubscribeDeadline;
 var underviser = result.instructorName;
 var underviseremail = result.instructorEmail;
 var underviserid = result.instructorId;
 var sted = result.locationName;
 var stedid = result.locationId;
 var stedadresse = result.locationAddress + ", " + result.locationZipCode + " " 
 + result.locationCity;
 var stedemail = result.locationEmail;
 var lokale = result.locationRoom;
 var pris = result.price;
 var aktiv = result.active;
 var pladser = result.maxParticipants;
 // array af kurser
 var kurser = result.courses;
 });
});

Undervisere


For at få en liste over alle dine undervisere, skal du bruge følgende URL:

docas.dk/api/instructors/{Read-Only API Key}/{Vendor ID}

Her er et eksempel fra udbyderen Bager- og Konditoriskolen:
docas.dk/api/instructors/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?format=jsonp

Du kan også hente data ud for en enkelt underviser. Her skal du bruge følgende URL:

docas.dk/api/instructor/{Read-Only API Key}/{Vendor ID}/{Underviser ID}

Underviser ID får du fra førnævnte liste. Et eksempel:
docas.dk/api/instructor/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f/d04b735c-75a8-40ab-a5c4-a45000ea3740?format=jsonp

Her er et JQuery eksempel, på hvordan du kan bruge API'et på din egen hjemmeside:


// Her hentes en liste over underviserne ud i en tabel med id="alleundervisere"
$(document).ready(function () {
 $.getJSON("https://docas.dk/api/instructors/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?callback=?", function (result) {
 for (var i = 0; i < result.length; i++) {
  var navn = "<td>" + result[i].name + "</td>";
  var email = "<td>" + result[i].email + "</td>";
  var mobil = "<td>" + result[i].mobile + "</td>";
  var telefon = "<td>" + result[i].phone + "</td>";
  var cv = "<td>" + result[i].cv + "</td>";
  var billede = "<td>" + result[i].imageURL + "</td>";
  $("#alleundervisere").append("<tr>" + navn + email + mobil + telefon + cv + billede + "</tr>");
 }
});

// her gemmes informationer om en enkelt underviser i variabler
$.getJSON("https://docas.dk/api/instructor/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f/d04b735c-75a8-40ab-a5c4-a45000ea3740?callback=?", function (result) {
  var iD = result.iD;
  var navn = result.name;
  var email = result.email;
  var mobil = result.mobile;
  var telefon = result.phone;
  var cv = result.cv;
  var billede = result.imageURL;
});
});

Steder


For at få en liste over alle dine steder, skal du bruge følgende URL:

docas.dk/api/locations/{Read-Only API Key}/{Vendor ID}

Her er et eksempel fra udbyderen Bager- og Konditoriskolen:
docas.dk/api/locations/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?format=jsonp

Du kan også hente data ud for et enkelt sted. Her skal du bruge følgende URL:

docas.dk/api/location/{Read-Only API Key}/{Vendor ID}/{Sted ID}

Sted ID får du fra førnævnte liste. Et eksempel:
docas.dk/api/location/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f/e489c6a6-1760-46c4-9c16-a45000ea588a?format=jsonp

Her er et JQuery eksempel, på hvordan du kan bruge API'et på din egen hjemmeside:


// Her hentes en liste over steder ud i en tabel med id="allesteder"
$(document).ready(function () {
 $.getJSON("https://docas.dk/api/locations/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?callback=?", function (result) {
 for (var i = 0; i < result.length; i++) {
   var navn = "<td>" + result[i].name + "</td>";
   var adresse = "<td>" + result[i].address + ", " + result[i].zipCode + " " 
   + result[i].city;
   var telefon = "<td>" + result[i].phone + "</td>";
   var email = "<td>" + result[i].email + "</td>";
   var www = "<td>" + result[i].wWW + "</td>";
   var beskrivelse = "<td>" + result[i].description + "</td>";
   $("#allesteder").append("<tr>" + navn + adresse + telefon + email + www
    + beskrivelse + "</tr>");
 }
});
 
// Her gemmes informationer om et enkelt sted i variabler
$.getJSON("https://docas.dk/api/location/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f/e489c6a6-1760-46c4-9c16-a45000ea588a?callback=?", function (result) {
 var iD = result.iD;
 var navn = result.name;
 var adresse = result.address + ", " + result.zipCode + " "
  + result.city;
 var telefon = result.phone;
 var email = result.email;
 var www = result.wWW;
 var beskrivelse = result.description;                
});
});
                        

Aktivitetslister


For at få en liste over dine aktivitetslister, skal du bruge følgende URL:

docas.dk/api/courselists/{Read-Only API Key}/{Vendor ID}

Her er et eksempel fra udbyderen Bager- og Konditoriskolen:
docas.dk/api/courselists/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?format=jsonp

For at hente data for en enkelt aktivitetsliste skal du bruge følgende URL:

docas.dk/api/courselist/{Read-Only API Key}/{Vendor ID}/{Aktivitetsliste ID}

Aktivitetsliste ID får du fra førnævnte liste. Et eksempel:
docas.dk/api/courselist/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f/54f700c7fe7e305aac7621bc?format=jsonp

Her er et JQuery eksempel, på hvordan du kan bruge API'et på din egen hjemmeside:


// her henter vi en liste over aktivitetslister ud i en tabel med id="allelister"
$(document).ready(function () {
 $.getJSON("https://docas.dk/api/courselists/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f?callback=?", function (result) {
 for (var i = 0; i < result.courseLists.length; i++) {
    var navn = "<td>" + result.courseLists[i].name + "</td>";
    var id = "<td>" + result.courseLists[i].iD + "</td>";
    $("#allelister").append("<tr>" + navn + id + "</tr>");
 }
});
      
// her gemmes informationerne om en enkelt aktivitetsliste i variabler
$.getJSON("https://docas.dk/api/courselist/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f/54f700c7fe7e305aac7621bc?callback=?", function (result) {
  var listeid = result.iD;
  // array med kurser på listen
  var kurser = result.courses;
});
});

Kurve/Køb


For at hente data for et gennemført køb skal du bruge følgende URL:

docas.dk/api/basket/{Read-Only API Key}/{Vendor ID}/{Kurv ID}

Kurv ID får du fra det postback som kommer fra tilmeldingsformularen ved et gennemført køb. Et eksempel:
docas.dk/api/basket/56e7c52f-32c8-4f6b-9ae8-4da7463ab2cd/49307ff0-edf4-48c1-b7a0-a45000e9df5f/018695bb-5d88-4a71-976a-85248fbda0c2?format=jsonp

Hvis du f.eks. har angivet http://www.bageriskolen.dk/kvittering som tilmeldings postback url, vil tilmeldingsformularen pege på http://www.bageriskolen.dk/kvittering?id=KurvID , som du så f.eks. behandler i din MVC controller.

Eksempler

Vi har lavet et par simple eksempelsider, der henter data ud via API'et, og viser dataene i simple tabeller. Husk at I kan se kildekoden ved at højreklikke og vælge "Vis kildetekst / Vis sidens kode" på de enkelte sider.


Udbyder

Kurser

Skabeloner

Undervisere

Steder

Aktivitetslister