REST-dokumentation (och ett litet önskemål)

Hjälp med plugins, tillägg (exempelvis webbtillägget) och exempelkod som inte ingår i Switch Kings officiella installationspaket
Forum rules
För att kunna hjälpa dig med supportfrågor behöver vi så mycket information som möjligt.
Innan du skapar en ny tråd, läs gärna:
viewtopic.php?f=10&t=20
Post Reply
riro
3 stars
3 stars
Posts: 161
Joined: Wed 11 Jan 2012, 16:40
Contact:

REST-dokumentation (och ett litet önskemål)

Post by riro » Tue 23 Oct 2012, 15:03

Har använt mig en hel del av denna: http://www.switchking.se/en/component/c ... rest-anrop

Men om man kör exempelvis /devices så finns det en hel del info som man ganska enkelt kan lista ut vad det är, men sen finns det vissa som man verkligen måste test & gissa sig fram till.

ModeID är ett bra exempel.

Hade underlättat "en del" om det finns dokumenterat vilka IDn som betyder vad.


Sen... en önskvärd funktion är:
/extendedservices/calculations/suninfo

Den behöver bara returnera när den går upp och när den går ner. (Eventuellt kanse man skulle kunna lägga på ?date=YYMMDD för att ta ett annat datum än dagens)
(Kör idag med en framgooglad funktion, och den räknar inte på samma sätt som SK)
http://switchqueen.snowland.se/ - Every king needs his queen

Martin
Administrator
Administrator
Posts: 2655
Joined: Tue 09 Nov 2010, 20:25

Re: REST-dokumentation (och ett litet önskemål)

Post by Martin » Tue 23 Oct 2012, 15:58

En fullständig dokumentation över ID blir svårt att hålla uppdaterad, skulle jag tro. Däremot finns de i Switch Kings databas och är därmed synlig för hugade spekulanter.

Vad de olika taggarna betyder kanske skulle kunna följa med i installationspaketet för servern:
http://bugnet.switchking.se/Issues/Issu ... spx?id=612
http://bugnet.switchking.se/Issues/Issu ... spx?id=613
Martin | Switch King

riro
3 stars
3 stars
Posts: 161
Joined: Wed 11 Jan 2012, 16:40
Contact:

Re: REST-dokumentation (och ett litet önskemål)

Post by riro » Tue 23 Oct 2012, 18:31

Martin wrote:En fullständig dokumentation över ID blir svårt att hålla uppdaterad, skulle jag tro. Däremot finns de i Switch Kings databas och är därmed synlig för hugade spekulanter.
Hur håller ni själva koll på IDn?
http://switchqueen.snowland.se/ - Every king needs his queen

Martin
Administrator
Administrator
Posts: 2655
Joined: Tue 09 Nov 2010, 20:25

Re: REST-dokumentation (och ett litet önskemål)

Post by Martin » Tue 23 Oct 2012, 19:09

De IDn som finns återfinns i databasen. De förändras inte (enhetstyper etc), däremot kan nya tillkomma.
Martin | Switch King

riro
3 stars
3 stars
Posts: 161
Joined: Wed 11 Jan 2012, 16:40
Contact:

Re: REST-dokumentation (och ett litet önskemål)

Post by riro » Wed 24 Oct 2012, 05:45

Martin wrote:De IDn som finns återfinns i databasen. De förändras inte (enhetstyper etc), däremot kan nya tillkomma.
Då kanske ett enkelt REST-anrop kan generera en lista med aktuella IDn...
http://switchqueen.snowland.se/ - Every king needs his queen

Martin
Administrator
Administrator
Posts: 2655
Joined: Tue 09 Nov 2010, 20:25

Re: REST-dokumentation (och ett litet önskemål)

Post by Martin » Wed 24 Oct 2012, 07:50

Smart tänkt - ibland tänker man inte längre än näsan räcker. :banghead:

Får fundera lite på hur det löses bäst.

Lagt till önskemålet i BugNet:
http://bugnet.switchking.se/Issues/Issu ... spx?id=614
Martin | Switch King

gorhak
3 stars
3 stars
Posts: 59
Joined: Wed 28 Sep 2011, 15:35
Location: Spånga

Re: REST-dokumentation (och ett litet önskemål)

Post by gorhak » Wed 24 Oct 2012, 08:25

Att enkelt kunna få fram IDnr skulle vara bra för utvecklare av Plugin. För användare som ska konfigurera existerande Plugin skulle jag önska att det fans en kolumn, gärna valbar, i klienten som visar IDnr för respektive Device, Source, Scenario och Systemmode. Denna funktion finns ju för Hus och Enhetskoder, men även för dessa så skulle en egen kolumn vara önskvärd istället för att de läggs sist i namnet.
/Göran

Martin
Administrator
Administrator
Posts: 2655
Joined: Tue 09 Nov 2010, 20:25

Re: REST-dokumentation (och ett litet önskemål)

Post by Martin » Wed 24 Oct 2012, 08:41

Instämmer - ID:n är viktiga för pluginskapande (en ID:n del viktigare än andra).

Om man jobbar med pluginutveckling så har man ju dock möjligheten att få fram dessa ID:n väldigt lätt ändå, exempelvis via SQLite Admin (http://sqliteadmin.orbmu2k.de/).

Vi måste helt enkelt väga vår tid och insats och jämföra vad som ger mest i förhållande till funktionsvinst. Då ID:n är lätt åtkomliga med ett verktyg kommer därmed åtkomst av ID:n att prioriteras lägre än andra funktionsförändringar. Med "lägre" dock inte sagt att det inte kommer, men risken att det skjuts på till förmån för andra funktioner är ju större ju lägre prioriteten är...

Något som dock kan öka prioriteten är ju efterfrågan på en specifik funktion.
Martin | Switch King

gorhak
3 stars
3 stars
Posts: 59
Joined: Wed 28 Sep 2011, 15:35
Location: Spånga

Re: REST-dokumentation (och ett litet önskemål)

Post by gorhak » Wed 24 Oct 2012, 09:11

Ja förstår Matrin, men jag tänkte främst få de användare som vill utnyttja Plugin och som inte har kunskaper inom programmering. Då kan syntaxen i .config-filer där man ofta refererar till ID var nog så förvirrande. Om det då fanns en vy där namn och ID enkelt framkom så kanske det skulle underlätta. Men ta det som ett önskemål sålänge.
/Göran

Martin
Administrator
Administrator
Posts: 2655
Joined: Tue 09 Nov 2010, 20:25

Re: REST-dokumentation (och ett litet önskemål)

Post by Martin » Wed 24 Oct 2012, 09:17

Aha...
Missuppfattade dig. Lägger till det som ett önskemål för klienten.

http://bugnet.switchking.se/Issues/Issu ... spx?id=615
Martin | Switch King

Post Reply

Who is online

Users browsing this forum: No registered users and 5 guests