API exempel

Arbetet med nästa version fortlöper. Tänkte berätta lite mer om det i version 4 utlovade API:t.

Nu blir det teknik, men i huvudsak är det enkelt, man gör ett anrop till en URL, och får ett XML baserat svar. I exemplet nedan används API:t för besökslistor.

Anropas med /api/visitorlist.aspx?[argument]

Argument:
apikey – API nyckel  – Krävs som autentisering. Hämtas vid internaanrop från xvis.config. Vid externa får man sätta nyckeln i externa programmet.
type – null/in/out/coming – null: returnerar en lista på dagens besökare, ej anlända och inne. in: returnerar en lista på dagens inreggade besökare. out: returnerar en lista på dagens utreggade besökare. coming: returnerar en lista på dagens kommande besökare.
strDay – datum, yyyy-mm-dd
limit – nummer –  Anger hur många besökare som max ska returneras.
usesettings – true/false – true: returnerar en lista baserat på systemets inställningar. false: returnerar en lista med alla fält i ett besöksobjekt.

Exempel anrop: https://localhost/api/visitorlist.aspx?apikey=ABCDE&type=in&textType=private&strDay=2009-09-08&limit=5&usesettings=false

Svaret, i XML format, ser ut som följer:

<visitorlist>
	<common>
		<date>2009-09-08</date>
		<headertext>Vi välkomnar idag</headertext>
	</common>
	<visitors>
		<visitor>
			<id>12973</id>
			<name>Bengt Karlsson</name>
			<company>SJ</company>
			<cardno>
			</cardno>
			<visitstext>Besöker</visitstext>
			<host>Bjarne Gårdebratt</host>
			<status>coming</status>
			<in/>
			<out/>
			<days>0</days>
			<time/>
			<info/>
			<Custom1/>
			<Custom2/>
			<Custom3/>
			<hidecompany>False</hidecompany>
			<hidevisitor>False</hidevisitor>
			<parkingticket>False</parkingticket>
			<wireless>False</wireless>
			<visiblefrom>Always</visiblefrom>
		</visitor>
		<visitor>
			<id>12974</id>
			<name>Anna Andersson</name>
			<company>Företaget AB</company>
			<cardno>
			</cardno>
			<visitstext>Besöker</visitstext>
			<host>Bjarne Gårdebratt</host>
			<status>in</status>
			<in>2009-09-08 13:27:14</in>
			<out/>
			<days>0</days>
			<time/>
			<info/>
			<Custom1>0702121212</Custom1>
			<Custom2>Ja</Custom2>
			<Custom3/>
			<hidecompany>False</hidecompany>
			<hidevisitor>False</hidevisitor>
			<parkingticket>False</parkingticket>
			<wireless>False</wireless>
			<visiblefrom>Always</visiblefrom>
		</visitor>
	</visitors>
</visitorlist>

Detta gör det mycket enkelt att plocka in information från besöksystemet till andra applikationer, t. ex SharePoint eller annan intranätmjukvara.

I svaret ovan kan den uppmärksamme se några nya fält, info, Custom1, Custom2 och Custom3. Dessa är också nya i version 4. Info kan användas för intern information och upp till 5 fritext fält som du kan använda till vad du vill kan användas vid besöksregistrering.