POST päring - Redigeerimiste ajalugu

Kaupo – 14. veebruar 2020, kell 13:56

2020-02-14T13:56:01Z

←Vanem redaktsioon		Redaktsioon: 14. veebruar 2020, kell 13:56
2. rida:		2. rida:
	===Päring===		===Päring===
	POST päringu näol on tegemist Standard Booksi andmete kirjutamise meetodiga, mis kasutab Rest API funktsionaalsust ja XML formaati. Järgnevalt on kirjeldatud, kuidas POST päringu tegemine Standard Booksi toimib.		POST päringu näol on tegemist Standard Booksi andmete kirjutamise meetodiga, mis kasutab Rest API funktsionaalsust ja XML formaati. Järgnevalt on kirjeldatud, kuidas POST päringu tegemine Standard Booksi toimib.

			NB: tegemist ei ole HansaWorldi standardse Rest APIga, antud leht kirjeldab funktsoooni, mis on kasutusel vai Excellentis.
	====Autoriseerimine päringu päises====		====Autoriseerimine päringu päises====
	<syntaxhighlight>		<syntaxhighlight>

Kaupo – 14. jaanuar 2019, kell 10:39

2019-01-14T10:39:32Z

←Vanem redaktsioon		Redaktsioon: 14. jaanuar 2019, kell 10:39
16. rida:		16. rida:
	*Content-Type: application/xml		*Content-Type: application/xml
	Kui kasutada autoriseerimist POST päringu päises, tuleb päringu päisesse lisada järgnevad osad:		Kui kasutada autoriseerimist POST päringu päises, tuleb päringu päisesse lisada järgnevad osad:
	*Authorization: Basic [base64 encoded user:password string]		*Authorization: Basic [base64 encoded user:password string] <invalid example
	**''Authorization: Basic ~~YXBpOmFwaQ~~==''		**''Authorization: Basic YXXBpOmn7FwaQ=='' <invalid example
	*''JSON not supported at the moment''		*''JSON not supported at the moment''
	====Päringu formaat (POST data)====		====Päringu formaat (POST data)====

Sven: /* Autoriseerimine URL'i abil */

2018-10-04T12:33:01Z

Autoriseerimine URL'i abil

←Vanem redaktsioon		Redaktsioon: 4. oktoober 2018, kell 12:33
2. rida:		2. rida:
	===Päring===		===Päring===
	POST päringu näol on tegemist Standard Booksi andmete kirjutamise meetodiga, mis kasutab Rest API funktsionaalsust ja XML formaati. Järgnevalt on kirjeldatud, kuidas POST päringu tegemine Standard Booksi toimib.		POST päringu näol on tegemist Standard Booksi andmete kirjutamise meetodiga, mis kasutab Rest API funktsionaalsust ja XML formaati. Järgnevalt on kirjeldatud, kuidas POST päringu tegemine Standard Booksi toimib.

	~~====Autoriseerimine URL'i abil====~~
	~~<syntaxhighlight>~~
	~~http://username:password@ipAddress:portNumber/WebPOSTAPI.hal?company=compNumber&param2=value&param3=value~~
	~~</syntaxhighlight>~~
	====Autoriseerimine päringu päises====		====Autoriseerimine päringu päises====
	<syntaxhighlight>		<syntaxhighlight>
15. rida:		10. rida:
	*compNumber on ettevõtte number Standard Books ettevõtete registris. (Numberatsioon algab 1'st)		*compNumber on ettevõtte number Standard Books ettevõtete registris. (Numberatsioon algab 1'st)
	Näide:<syntaxhighlight>		Näide:<syntaxhighlight>
	http://~~testuser:testpassword@~~localhost:1639/WebPOSTAPI.hal?company=1		http://localhost:1639/WebPOSTAPI.hal?company=1
	</syntaxhighlight>		</syntaxhighlight>
	====Päringu päis====		====Päringu päis====
22. rida:		17. rida:
	Kui kasutada autoriseerimist POST päringu päises, tuleb päringu päisesse lisada järgnevad osad:		Kui kasutada autoriseerimist POST päringu päises, tuleb päringu päisesse lisada järgnevad osad:
	*Authorization: Basic [base64 encoded user:password string]		*Authorization: Basic [base64 encoded user:password string]
	**''~~example~~ Authorization: Basic YXBpOmFwaQ==''		**''Authorization: Basic YXBpOmFwaQ==''
	*''JSON not supported at the moment''		*''JSON not supported at the moment''
	====Päringu formaat (POST data)====		====Päringu formaat (POST data)====

Tanel: /* Lisamine/Muutmine/Kustutamine */

2018-08-22T09:56:35Z

Lisamine/Muutmine/Kustutamine

←Vanem redaktsioon		Redaktsioon: 22. august 2018, kell 09:56
35. rida:		35. rida:
	</syntaxhighlight>		</syntaxhighlight>
	** Muutmine ('''UPDATE''')		** Muutmine ('''UPDATE''')
	*** ''Näide:''<syntaxhighlight lang="xml">		*** "Update" Kasutamise kommentaarid: - Registrite puhul ("Vc" suffiksiga kirjed) "update" funktsiooni puhul XML-is kõigepealt peab olema antud kohustuslik väli (või mitu, kui on nii eraldi mainitud), mis unikaalselt määrab (määravad) ära millist kirjet muudetakse. See on väli mille järgi Books leiab õiget registri kirjet. Kui seda välja XMLis ei ole, kohe tagastatakse veateadet. - Blokide puhul ("Block" suffiksiga kirjed) on tegemist ainult ühe kirjega, ehk kõik muudatused asuvad ainult ühes kohas ning valikut ei ole. - Ülejäänud XML tag-id ei ole kohustuslikud. - Need tag-id mis on edastatud, peavad olema korrektse sisuga. Näiteks, et aadressi rida kirjutada tühja reaga üle (ehk kustutada aadressi rida), vaja edastada vastava välja nimega XML tagi tühja sisuga, mis on lubatud. Kui on tegemist CheckBox-ga või näiteks RadioButton-iga, siis need peavad olema vastavalt formaadile täidetud, näiteks kas "0" või "1" ning tühjad väärtused sel juhul ei ole lubatud. Sama näidis oleks ka KM koodiga seoses, KM koodi ei tohi muuta ebaeksisteeriva KM koodi vastu.
			***''Näide:''<syntaxhighlight lang="xml">
	<data register="CYBlock" method="update" sequence="106357" systemversion="8.4.20.504">		<data register="CYBlock" method="update" sequence="106357" systemversion="8.4.20.504">
	</syntaxhighlight>		</syntaxhighlight>
61. rida:		62. rida:
	*<s>sequence="106357" systemversion="8.4.20.504" are not used in API right now, only used for example, can ignore it for the moment.</s>		*<s>sequence="106357" systemversion="8.4.20.504" are not used in API right now, only used for example, can ignore it for the moment.</s>

	===== Lisamine/Muutmine/Kustutamine =====		===== <s>Lisamine/Muutmine/Kustutamine</s> =====
	POST päring, kasutades Rest API funktsionaalsust, võimaldab sisestusi Standard Books tarkvaras:		<s>POST päring, kasutades Rest API funktsionaalsust, võimaldab sisestusi Standard Books tarkvaras:</s>
	* '''Lisada'''		* '''<s>Lisada</s>'''

	''Näide:~~''<syntaxhighlight lang="xml">~~		''<s>Näide:</s>''
	~~<data register="CYBlock" method="create" sequence="106357" systemversion="8.4.20.504">~~		* '''<s>Muuta</s>'''
	</~~syntaxhighlight~~>
	* '''Muuta'''

	''Näide:~~''<syntaxhighlight lang="xml">~~		''<s>Näide:</s>''
	~~<data register="CYBlock" method="update" sequence="106357" systemversion="8.4.20.504">~~
	</~~syntaxhighlight~~>~~"Update" Kasutamise kommentaarid:~~

	- Registrite puhul ("Vc" suffiksiga kirjed) "update" funktsiooni puhul XML-is kõigepealt peab olema antud kohustuslik väli (või mitu, kui on nii eraldi mainitud), mis unikaalselt määrab (määravad) ära millist kirjet muudetakse. See on väli mille järgi Books leiab õiget registri kirjet. Kui seda välja XMLis ei ole, kohe tagastatakse veateadet.		* '''<s>Kustutada</s>'''

	~~- Blokide puhul ("Block" suffiksiga kirjed) on tegemist ainult ühe kirjega, ehk kõik muudatused asuvad ainult ühes kohas ning valikut ei ole.~~		''<s>Näide:</s>''

	~~- Ülejäänud XML tag-id ei ole kohustuslikud.~~

	- Need tag-id mis on edastatud, peavad olema korrektse sisuga. Näiteks, et aadressi rida kirjutada tühja reaga üle (ehk kustutada aadressi rida), vaja edastada vastava välja nimega XML tagi tühja sisuga, mis on lubatud. Kui on tegemist CheckBox-ga või näiteks RadioButton-iga, siis need peavad olema vastavalt formaadile täidetud, näiteks kas "0" või "1" ning tühjad väärtused sel juhul ei ole lubatud. Sama näidis oleks ka KM koodiga seoses, KM koodi ei tohi muuta ebaeksisteeriva KM koodi vastu.

	* '''Kustutada'''

	''Näide:~~''<syntaxhighlight lang="xml">~~
	~~<data register="CYBlock" method="delete" sequence="106357" systemversion="8.4.20.504">~~
	</~~syntaxhighlight~~>

Tanel: /* Request body (POST data) format */

2018-08-15T13:31:45Z

Request body (POST data) format

@@ 24. rida: / 24. rida: @@
 **''example Authorization: Basic YXBpOmFwaQ==''
 *''JSON not supported at the moment''
-====Request body (POST data) format====
+====Päringu formaat (POST data)====
 Iga registri päringu väljade ja formaadi kirjeldused leiab siit:

Konstantin: "Update" Kasutamise kommentaarid:

2018-08-13T13:05:51Z

"Update" Kasutamise kommentaarid:

←Vanem redaktsioon		Redaktsioon: 13. august 2018, kell 13:05
56. rida:		56. rida:
	''Näide:''<syntaxhighlight lang="xml">		''Näide:''<syntaxhighlight lang="xml">
	<data register="CYBlock" method="update" sequence="106357" systemversion="8.4.20.504">		<data register="CYBlock" method="update" sequence="106357" systemversion="8.4.20.504">
	</syntaxhighlight>		</syntaxhighlight>"Update" Kasutamise kommentaarid:

			- Registrite puhul ("Vc" suffiksiga kirjed) "update" funktsiooni puhul XML-is kõigepealt peab olema antud kohustuslik väli (või mitu, kui on nii eraldi mainitud), mis unikaalselt määrab (määravad) ära millist kirjet muudetakse. See on väli mille järgi Books leiab õiget registri kirjet. Kui seda välja XMLis ei ole, kohe tagastatakse veateadet.

			- Blokide puhul ("Block" suffiksiga kirjed) on tegemist ainult ühe kirjega, ehk kõik muudatused asuvad ainult ühes kohas ning valikut ei ole.

			- Ülejäänud XML tag-id ei ole kohustuslikud.

			- Need tag-id mis on edastatud, peavad olema korrektse sisuga. Näiteks, et aadressi rida kirjutada tühja reaga üle (ehk kustutada aadressi rida), vaja edastada vastava välja nimega XML tagi tühja sisuga, mis on lubatud. Kui on tegemist CheckBox-ga või näiteks RadioButton-iga, siis need peavad olema vastavalt formaadile täidetud, näiteks kas "0" või "1" ning tühjad väärtused sel juhul ei ole lubatud. Sama näidis oleks ka KM koodiga seoses, KM koodi ei tohi muuta ebaeksisteeriva KM koodi vastu.

	* '''Kustutada'''		* '''Kustutada'''

Tanel: /* Lisamine/Muutmine/Kustutamine */

2018-08-13T08:10:05Z

Lisamine/Muutmine/Kustutamine

←Vanem redaktsioon		Redaktsioon: 13. august 2018, kell 08:10
47. rida:		47. rida:
	===== Lisamine/Muutmine/Kustutamine =====		===== Lisamine/Muutmine/Kustutamine =====
	POST päring, kasutades Rest API funktsionaalsust, võimaldab sisestusi Standard Books tarkvaras:		POST päring, kasutades Rest API funktsionaalsust, võimaldab sisestusi Standard Books tarkvaras:
	* Lisada		* '''Lisada'''
	**
	* Muuta		''Näide:''<syntaxhighlight lang="xml">
	**		<data register="CYBlock" method="create" sequence="106357" systemversion="8.4.20.504">
	* Kustutada		</syntaxhighlight>
	**		* '''Muuta'''

			''Näide:''<syntaxhighlight lang="xml">
			<data register="CYBlock" method="update" sequence="106357" systemversion="8.4.20.504">
			</syntaxhighlight>
			* '''Kustutada'''

			''Näide:''<syntaxhighlight lang="xml">
			<data register="CYBlock" method="delete" sequence="106357" systemversion="8.4.20.504">
			</syntaxhighlight>

Tanel: /* Lisamine/Muutmine/Kustutamine */

2018-08-10T11:12:51Z

Lisamine/Muutmine/Kustutamine

←Vanem redaktsioon		Redaktsioon: 10. august 2018, kell 11:12
45. rida:		45. rida:
	*<s>sequence="106357" systemversion="8.4.20.504" are not used in API right now, only used for example, can ignore it for the moment.</s>		*<s>sequence="106357" systemversion="8.4.20.504" are not used in API right now, only used for example, can ignore it for the moment.</s>

	=== Lisamine/Muutmine/Kustutamine ===		===== Lisamine/Muutmine/Kustutamine =====
			POST päring, kasutades Rest API funktsionaalsust, võimaldab sisestusi Standard Books tarkvaras:
			* Lisada
			**
			* Muuta
			**
			* Kustutada
			**

Tanel: /* Päring */

2018-08-09T13:30:23Z

Päring

←Vanem redaktsioon		Redaktsioon: 9. august 2018, kell 13:30
1. rida:		1. rida:
	[[Hausing\|Hausing - Pealeht]]		[[Hausing\|Hausing - Pealeht]]
	===Päring===		===Päring===
			POST päringu näol on tegemist Standard Booksi andmete kirjutamise meetodiga, mis kasutab Rest API funktsionaalsust ja XML formaati. Järgnevalt on kirjeldatud, kuidas POST päringu tegemine Standard Booksi toimib.

	====Autoriseerimine URL'i abil====		====Autoriseerimine URL'i abil====
	<syntaxhighlight>		<syntaxhighlight>

Tanel: /* Request body (POST data) format */

2018-08-09T12:10:14Z

Request body (POST data) format

←Vanem redaktsioon		Redaktsioon: 9. august 2018, kell 12:10
23. rida:		23. rida:
	*''JSON not supported at the moment''		*''JSON not supported at the moment''
	====Request body (POST data) format====		====Request body (POST data) format====

			Iga registri päringu väljade ja formaadi kirjeldused leiab siit:

			[[Hausing\|'''Hausing - Pealeht''']]

	<s>Must be in XML format.</s>		<s>Must be in XML format.</s>