Rest API POST doc from HansaWorld - Redigeerimiste ajalugu

Kaupo: /* Muudame koostatud arvel kogust */

2019-03-05T13:48:17Z

Muudame koostatud arvel kogust

←Vanem redaktsioon		Redaktsioon: 5. märts 2019, kell 13:48
264. rida:		264. rida:
	</syntaxhighlight>Vastuseks on samasugune arve XML, nagu arve postitamisel, vaid kogus on muutunud 3-ks.		</syntaxhighlight>Vastuseks on samasugune arve XML, nagu arve postitamisel, vaid kogus on muutunud 3-ks.
	[[Pilt:Kogus 3.png\|tühi\|pisi\|569x569px]]		[[Pilt:Kogus 3.png\|tühi\|pisi\|569x569px]]

			==== Muudame Arvel artiklit, kogust, kirjeldust ja hinda ====
			Oletame, et sooime arvel vahetada artiklit, kogust ja hinda ning lisada kaks uut rida kirjeldusega (nö täiendavad kirjeldavad read)<syntaxhighlight lang="text">
			set_row_field.0.ArtCode=0032251100060&
			set_row_field.0.Quant=1&
			set_row_field.0.Price=4000&
			set_row_field.0.Spec=M20 EX stainless steel 316 Maxed Out&
			set_row_field.1.Spec=Description here: neti.ee&
			set_row_field.2.Spec=Refund, when broken or pieces missing&
			</syntaxhighlight>Tulemus on selline:
			[[Pilt:Lisatud read.png\|tühi\|pisi\|574x574px]]

			==== Kinnitame arve ====
			<syntaxhighlight lang="text">
			Request: https://mars.excellent.ee:4455/api/1/IVVc/2180325
			Method: Patch
			Headers: Authorization: Basic [user:pass in base64] example: dXNlcjpwYXNz
			Body:
			set_field.OKFlag=1&
			</syntaxhighlight>tekkis viga, puudu on konto käibemaksukoodi pealt. Kuidas seda tean? Sest sain vastu veateate:<syntaxhighlight lang="xml">
			<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
			<message description="TAX Account not found, check VAT Codes"></message>
			<error code="20078" description="TAX Account not found, check VAT Codes" row="-1" field="-1"></error>
			</syntaxhighlight>Parandasin vea, seejärel sain tulemuseks OK ning tulemus:
			[[Pilt:OK tulemus.png\|tühi\|pisi\|549x549px]]

Kaupo: /* Koostame arve, kasutame loodud artiklit ja klienti */

2019-02-28T14:00:52Z

Koostame arve, kasutame loodud artiklit ja klienti

←Vanem redaktsioon		Redaktsioon: 28. veebruar 2019, kell 14:00
251. rida:		251. rida:
	</data>		</data>
	</syntaxhighlight>Nagu näha, on arvele kandunud korrektselt objektid, kliendi kontaktisikud jms, mida me postitasime algsetele kaartidele.		</syntaxhighlight>Nagu näha, on arvele kandunud korrektselt objektid, kliendi kontaktisikud jms, mida me postitasime algsetele kaartidele.

			NB: On oluline ka lisatava info järjekord. Näiteks, kui lisate tasumistingimuse koodi, seejärel kontakti koodi ning sellel kontaktil ei ole Müügi Tasumistingimus täidetud, siis saate veateate, et tasumistingimus on tühi. Õige järjekord antud juhul oleks Kontaktikood, peale seda tasumistingimus. Sama reegel on objektidega - need lisada peale kontakti, ridadel peale Kontot või Artiklit.

	==== Muudame koostatud arvel kogust ====		==== Muudame koostatud arvel kogust ====

Kaupo: /* Muudame koostatud arvel kogust */

2019-02-25T09:00:34Z

Muudame koostatud arvel kogust

←Vanem redaktsioon		Redaktsioon: 25. veebruar 2019, kell 09:00
54. rida:		54. rida:

	=== Lihtsad POSTi näited ===		=== Lihtsad POSTi näited ===
			POST meetodiga saab tekitada uusi dokumente

			PATCH meetodiga saab muuta olemasolevaid kaarte (ei pea kaasa saatma kogu kaardi sisu, muudetava dokumendi nr sisaldub URLis)

	==== Koostame kliendi ====		==== Koostame kliendi ====

Kaupo – 25. veebruar 2019, kell 08:57

2019-02-25T08:57:25Z

←Vanem redaktsioon		Redaktsioon: 25. veebruar 2019, kell 08:57
248. rida:		248. rida:
	</data>		</data>
	</syntaxhighlight>Nagu näha, on arvele kandunud korrektselt objektid, kliendi kontaktisikud jms, mida me postitasime algsetele kaartidele.		</syntaxhighlight>Nagu näha, on arvele kandunud korrektselt objektid, kliendi kontaktisikud jms, mida me postitasime algsetele kaartidele.

			==== Muudame koostatud arvel kogust ====
			<syntaxhighlight lang="text">
			Request: https://mars.excellent.ee:4455/api/1/IVVc/2180325
			Method: Patch
			Headers: Authorization: Basic [user:pass in base64] example: dXNlcjpwYXNz
			Body:
			set_row_field.0.Quant=3'&

			</syntaxhighlight>Vastuseks on samasugune arve XML, nagu arve postitamisel, vaid kogus on muutunud 3-ks.
			[[Pilt:Kogus 3.png\|tühi\|pisi\|569x569px]]

Kaupo: /* Koostame arve */

2019-02-14T13:51:50Z

Koostame arve

←Vanem redaktsioon		Redaktsioon: 14. veebruar 2019, kell 13:51
162. rida:		162. rida:
	Müüme postitatud artikli postitatud kliendile maha.		Müüme postitatud artikli postitatud kliendile maha.

	==== Koostame arve ====		==== Koostame arve, kasutame loodud artiklit ja klienti ====
	<syntaxhighlight lang="text">		<syntaxhighlight lang="text">
	Request: https://mars.excellent.ee:4455/api/1/IVVc/		Request: https://mars.excellent.ee:4455/api/1/IVVc/

Kaupo – 14. veebruar 2019, kell 13:50

2019-02-14T13:50:03Z

Näita muudatusi

Kaupo: Uus lehekülg: '==== Writing Data to Standard ERP ==== Functionally RecordNew will be called, then each set command will be called in order with it's respective window actions (to fill e.g. cust...'

2019-02-13T13:05:26Z

Uus lehekülg: '==== Writing Data to Standard ERP ==== Functionally RecordNew will be called, then each set command will be called in order with it's respective window actions (to fill e.g. cust...'

Uus lehekülg

==== Writing Data to Standard ERP ====
Functionally RecordNew will be called, then each set command will be called in order with it's respective window actions (to fill e.g. customer's name and payment terms). Finally the record will be inserted calling the same record actions as if a user did it with a client. There is no limit to the number of set commands you can issue, they can be either in the url or in post data. Only fields with non-default (non blank) data is returned.

Note the "url" parameter that uniquely identifies the created record. If you have more than one field in the main key these fields will be separated by '/'. If the main key contains special characters they will be url encoded.

In case of any messages that user would receive when entering the data manually, these messages will be returned in following format: <code><message description='message_text'></message></code>

In case of error while inserting/updating a record, following will be returned: <code><error code='error_code' description='error description' row='row_no' field='field_name'></error></code>

==== POST ====
To create new records you POST to the registers. The 'set' commands have the same syntax and functionality as with POST.

''Example'':

curl -X POST '<nowiki>http://SJ:@127.0.0.1:8080/api/1/IVVc?set_field.CustCode=001&set_row_field.0.ArtCode=10101&set_row_field.0.Quant=3'</nowiki>;

The reply will be in this format:<syntaxhighlight lang="xml">
<data register="IVVc" sequence="9693" url="/api/1/IVVc/10000014" systemversion="8.5.15.5" <IVVc>
<SerNr>10000010</SerNr>
<InvDate>2018-05-30</InvDate>
<CustCode>001</CustCode>
<Math/>
<PayDate>2018-06-29</PayDate>
<Addr0>Against All Odds Trading Co</Addr0> ... <rows>
<row rownumber="0">
<stp>1</stp>
<ArtCode>10101</ArtCode>
<Quant>3</Quant>
<Price>25.00</Price>
<Sum>71.25</Sum>
</syntaxhighlight>

This will create a new invoice for 001 customer, adding 3 10101 items.

==== PATCH ====
To change an existing record you PATCH the url given in the POST command.

''Example'':

curl -X PATCH '<nowiki>http://SJ:@127.0.0.1:8080/api/1/IVVc/10000014?set_row_field.0.Quant=100'</nowiki>

The reply will be in the same format:<syntaxhighlight lang="xml">
<data register="IVVc" sequence="9729" url="/api/1/IVVc/10000014" systemversion="8.5.15.6" <IVVc>
<SerNr>10000014</SerNr> ... <rows>
<row rownumber="0">
<stp>1</stp>
<ArtCode>10101</ArtCode>
<Quant>100</Quant>
<Price>25.00</Price>
<Sum>2375.00</Sum>
</syntaxhighlight>

This will change the quantity to 100.