POST päring
Redaktsioon seisuga 9. august 2018, kell 12:10 kasutajalt Tanel (arutelu | kaastöö) (→Request body (POST data) format)
Päring
Autoriseerimine URL'i abil
http://username:password@ipAddress:portNumber/WebPOSTAPI.hal?company=compNumber¶m2=value¶m3=value
Autoriseerimine päringu päises
http://ipAddress:portNumber/WebPOSTAPI.hal?company=compNumber¶m2=value¶m3=value
and additional header
Authorization: Basic [base64 encoded user:password string]
Nõutud parameetrid:
- compNumber on ettevõtte number Standard Books ettevõtete registris. (Numberatsioon algab 1'st)
Näide:
http://testuser:testpassword@localhost:1639/WebPOSTAPI.hal?company=1
Päringu päis
Päringu päise kohustuslikud osad:
- Content-Type: application/xml
Kui kasutada autoriseerimist POST päringu päises, tuleb päringu päisesse lisada järgnevad osad:
- Authorization: Basic [base64 encoded user:password string]
- example Authorization: Basic YXBpOmFwaQ==
- JSON not supported at the moment
Request body (POST data) format
Iga registri päringu väljade ja formaadi kirjeldused leiab siit:
Must be in XML format.
General format template as follows.
Notes:
<rows> element is optional;IVVc is the internal system name of Invoice register in Hansa. Only following registers are supported at the moment:IVVc - InvoicesCUVc - ContactsINVc - Items
the register name (“IVVc”) is now included into <data> element of request body, but is subject to review and may be moved to URL as parameter instead.Possible to pass several <IVVc> elements to send several records.“method” attribute of the <data> element defines the action. Actions supported at the moment: “create”, “delete”.sequence="106357" systemversion="8.4.20.504" are not used in API right now, only used for example, can ignore it for the moment.