QX_WEB_RETURN_VALUES

Controls a web service function output format.

Syntax

QX_WEB_RETURN_VALUES={ARRAY, OBJECT, AS_IS}

Possible Values

ARRAY

OBJECT

AS_IS

Usage and Examples

Use with Lycia Web API.

Example 1

TYPE rec_t RECORD

f1 STRING ATTRIBUTES(json_name = "nickname"),

f2 INT ATTRIBUTES(json_name = "count")

END RECORD

 

FUNCTION myfunc() RETURNS rec_t

DEFINE ret rec_t

LET ret.f1 = "batman"

LET ret.f2 = 8

RETURN ret

END FUNCTION

ARRAY : responses [ { "nickname" : "batman", "count" : 8 } ]

OBJECT : responses { "ret" : { "nickname" : "batman", "count" : 8 } }

AS_IS : responses { "nickname" : "batman", "count" : 8 }. This format will work if a function returns only one value. If a function returns more than one value, then values will be covered in a JSON array.

Example 2

FUNCTION myfunc()

DEFINE count INT

LET count = 8

RETURN count

END FUNCTION

ARRAY : responses [ 8 ]

OBJECT : responses { "count" : 8 }

AS_IS : responses 8

Example 3

FUNCTION myfunc()

DEFINE count INT

DEFINE nickname STRING

LET count = 8

LET nickname = "batman"

RETURN nickname, count

END FUNCTION

ARRAY : responses [ "batman", 8 ]

OBJECT : responses { nickname : "batman", "count" : 8 }

AS_IS : responses [ "batman", 8 ]

 

 

Contact Us

Privacy Policy

Copyright © 2025 Querix, (UK) Ltd.