SOAP - nyheter 21/2-18

Här skriver vi oftast om större nyheter, förändringar som syns och påverkar de flesta av våra användare. Idag gör vi dock en liten utflykt bakom kulisserna. Vi har nämligen gjort en del förändringar i SOAP-API:et under de senaste månaderna som vi tänkte sammanfatta här.

I korthet används SOAP-API:et för alla sorters import och export av objekt och bokningar, och dessutom för integrationer mellan TimeEdit och andra system. Har just du någon i din närhet som ansvarar för en integration med TimeEdit får du mer än gärna tipsa personen om detta, det kan finnas nyttiga nyheter här!

Ändringarna är rena tillägg — om din integration inte vill använda funktionerna fortsätter den att fungera och se precis likadan ut som tidigare.

Start- och slutdatum på medlemskap

När objekt importeras har man sedan länge kunnat definiera andra objekt som medlemmar och relaterade. Sedan några versioner tillbaka går det också att ange start- och slutdatum för både medlemskap och relationer. På så sätt kan man till exempel hantera att en elev bara är medlem av en viss klass under ett givet läsår.

För att importera start- och sluttider har nya valfria fält tillkommit i XML-strukturen för objektimport: memberBeginTimes, memberEndTimes, relatedBeginTimes och relatedEndTimes. Samtliga är listor av ICAL-tidsstämplar på samma format som övriga tidsangivelser.

Om tider ska anges måste listorna innehålla lika många element som det finns medlemmar eller relaterade, men det går att ange tom sträng om man inte vill ange start- eller sluttid på vissa objekt.

Vid export av objekt har en parameter tillkommit för att välja att man även vill ha ut relationers tider. Parametern heter includerelationtimes och sätts till true om tidselementen ska tas med. Sätts den till false eller utelämnas kommer tider inte att inkluderas i exporten.

Importera bokningar som annan användare

Regeln i TimeEdit är att den som utför en förändring alltid noteras i bokningen. Detta har inneburit att en integrations användare alltid blivit satt som senaste ändrare av bokningar som skapas eller uppdateras via import. Men naturligtvis kan man vilja behålla den senaste person som ändrade bokningen, eller göra import av nya bokningar för en annan användares räkning. Därför har vi lagt till det valfria fältet newmodifiedby som helt enkelt är ett användar-ID vilket sätts som ändrare av bokningen istället för integrationens användare. Villkoret är att användaren som utför importen står som skapare av bokningen.

Sök avbokningar på bokningsläge

Bokningar har länge kunnat sökas på bokningsläge, så att man enkelt kunnat hitta exempelvis alla schemaläggningsbokningar inom en viss tidsperiod. Nu finns denna möjlighet även vid sökning av avbokningar, parametern heter templategroup och fungerar precis som motsvarande parameter i andra anrop.

Var denna artikel till hjälp?
0 av 0 tyckte detta var till hjälp

Kommentarer

0 kommentarer

logga in för att lämna en kommentar.