Skip to main content

Return response as JSON object

Returns the response body as a collection from JSON

Function ReturnResponseAsJSONObject(Val ToMap = True, Val ExceptionOnError = False) Export

ParameterCLI optionTypeRequiredDescription
ToMap-BooleanUse map instead of structure
ExceptionOnError-BooleanCauses an exception with a log if there were errors during processing

Returns: Arbitrary - The response or the same processing object


caution

NOCLI: this method is not available in CLI version


1C:Enterprise/OneScript code example
    URL = "https://httpbin.org";
URL = URL + "/post";

Image = "https://api.athenaeum.digital/test_data/picture.jpg"; // URL, Path or Binary Data

Result = OPI_HTTPRequests.NewRequest()
.Initialize(URL)
.SetBinaryBody(Image)
.ProcessRequest("POST")
.ReturnResponseAsJSONObject(); // <---
Result
{
"args": {},
"data": "...",
"files": {},
"form": {},
"headers": {
"Accept": "*/*",
"Accept-Charset": "utf-8",
"Accept-Encoding": "gzip",
"Content-Length": "2114023",
"Content-Type": "application/octet-stream",
"Host": "httpbin.org",
"User-Agent": "1Script v$1.9.2.10",
"X-Amzn-Trace-Id": "Root=1-682cd706-2463a6de4b24c0800035f908"
},
"json": null,
"origin": "***",
"url": "https://httpbin.org/post"
}