How to pass xml to interface based service

tomek · 2018-07-26 06:24:19

Hi
I'm trying to pass pure xml to interface based service with no success. It only works if xml is enclosed in brackets ["<?xml version="1.0" encoding="UTF-8" ?><notify>...</notify>"], otherwise it throws 406-bad input parameters.

Method is declared as follows:

function TNotifySrv.Test(aXml: UTF8String): UTF8String;

Test ajax request:

POST /notify/NotifySrv.Test HTTP/1.1
Host: xx.xx.xx.xx:8092
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:61.0) Gecko/20100101 Firefox/61.0
Accept: */*
Accept-Language: pl,en-US;q=0.7,en;q=0.3
Accept-Encoding: gzip, deflate
Content-Length: 96
Content-Type: text/plain;charset=UTF-8
Origin: null
Connection: keep-alive

<?xml version="1.0" encoding="UTF-8" ?><notify>...</notify>

Regards, Tomek

ab · 2018-07-26 07:00:21

XML is not handled as input from interface-based services.
It expects JSON content.
Either with brackets (one item per input argument), or as a JSON object (one field per argument).
See https://synopse.info/files/html/Synopse … #TITLE_448

To handle any kind of input, including a pure XML body, use a method-based service.

tomek · 2018-07-26 09:36:48

ab wrote:

It expects JSON content.
Either with brackets (one item per input argument), or as a JSON object (one field per argument).

I've tried JSON object, but service received empty input

POST /notify/NotifySrv.Test HTTP/1.1
Host: xx.xx.xx.xx:8092
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:61.0) Gecko/20100101 Firefox/61.0
Accept: */*
Accept-Language: pl,en-US;q=0.7,en;q=0.3
Accept-Encoding: gzip, deflate
Content-Length: 75
Content-Type: text/plain;charset=UTF-8
Origin: null
Connection: keep-alive

{"notify": {"event": "TEST", "timestamp": "1532530174.872"}, "alert": null}

ab · 2018-07-26 10:08:33

Are you sure the JSON object matches the service input parameters?
Ensure you read https://synopse.info/files/html/Synopse … #TITLE_448

EMartin · 2018-07-26 10:17:57

try this:

function TNotifySrv.Test(notify: UTF8String): UTF8String;

rename argument "aXml" to "notify".

Regards.

Esteban

Chaa · 2018-07-26 10:49:21

And try use RawJSON:

function TNotifySrv.Test(notify: RawJSON): UTF8String;

tomek · 2018-07-26 11:27:02

Ok, now I understand how matching parameters and JSON values works.
But it works only for flat JSON, eg:

{"notify": "event_test", "alert": null}

For nested JSON objects

{"notify": {"event": "TEST", "timestamp": "1532530174.872"}, "alert": null}

it throws 406: "INotifySrv.Test failed on notify:UTF8String [missing or invalid value]"

Is it possible to receive nested JSON objects?

Thx for all answers
Regards, Tomek

Chaa · 2018-07-26 12:22:33

See RawJSON type of parameter in https://synopse.info/files/html/Synopse … l#TITL_154

tomek · 2018-07-26 13:47:50

Thx! now it works like charm
Btw: what is the easiest way to extract fields from simple JSON? (eg "event" from Notify example above)
I'm using TJSONTable, but is seems to "heavy" for this purpose.

Regards, Tomek

ab · 2018-07-26 14:28:40

You can use e.g. a TDocVariant:

function TNotifySrv.Test(const notify, alert: variant): RawJSON;
var e: RawUTF8;
begin
  e := notify.event;  // it works!
end;

Or define a record:

type
  TNotifyRec = packed record
     event: RawUTF8;
     timestamp: double;
  end;
function TNotifySrv.Test(const notify: TNotifyRec; const alert: variant): RawJSON;

// and needed under oldest versions of Delphi or with FPC:
initialization
  TJSONSerializer.RegisterCustomJSONSerializerFromText([
    TypeInfo(TNotifyRec ), 'event:RawUTF8 timestamp:double']);
end.

Or use a TSynPersistent with published properties:

type
  TNotifyObject = class(TSynPersistent)
  ...
  published
     property event: RawUTF8 read fEvent write fEvent;
     property timestamp: double read fTimeSTamp write fTimeSTamp;
  end;
function TNotifySrv.Test(const notify: TNotifyObject; const alert: variant): RawJSON;

tomek · 2018-07-27 08:19:28

ab wrote:

You can use e.g. a TDocVariant:

function TNotifySrv.Test(const notify, alert: variant): RawJSON;
var e: RawUTF8;
begin
  e := notify.event;  // it works!
end;

It's a kind of magic

Thx once more.

Regards, Tomek

jaclas · 2018-07-27 08:47:20

Variant is a magic, but without compile time checked and code insight. And it is quite slow.

ab · 2018-07-27 22:01:45

Why slow?
TDocVariant is not so slow in practice, just a few nanoseconds slower than direct access.
For transmitted parameters, you can retrieve it once into a local variable, if you want to use it in a loop for instance.

jaclas · 2018-07-28 07:02:27

Ok, I read this article http://blog.synopse.info/post/2011/07/0 … te-binding and now I know that mORMot has own late binding, and fast :-)

mORMot Open Source

#1 2018-07-26 06:24:19

How to pass xml to interface based service

#2 2018-07-26 07:00:21

Re: How to pass xml to interface based service

#3 2018-07-26 09:36:48

Re: How to pass xml to interface based service

#4 2018-07-26 10:08:33

Re: How to pass xml to interface based service

#5 2018-07-26 10:17:57

Re: How to pass xml to interface based service

#6 2018-07-26 10:49:21

Re: How to pass xml to interface based service

#7 2018-07-26 11:27:02

Re: How to pass xml to interface based service

#8 2018-07-26 12:22:33

Re: How to pass xml to interface based service

#9 2018-07-26 13:47:50

Re: How to pass xml to interface based service

#10 2018-07-26 14:28:40

Re: How to pass xml to interface based service

#11 2018-07-27 08:19:28

Re: How to pass xml to interface based service

#12 2018-07-27 08:47:20

Re: How to pass xml to interface based service

#13 2018-07-27 22:01:45

Re: How to pass xml to interface based service

#14 2018-07-28 07:02:27

Re: How to pass xml to interface based service

Board footer