Changes

All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/web</nowiki></code> namespace, which is statically bound to the {{Code|web}} prefix.<br/>All errors are assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.

|{{Func|web:create-url|$url as xs:string, $parameters as map(item(*)|xs:string}}<br/>{{Func|web:create-url|$url as xs:string, item$parameters as map()*), $anchor as xs:string|xs:string}}<br/>

|Creates a new URL from the specified <code>$url</code> string and the , query string <code>$parameters</code> specified in a mapand an optional {{Code|$anchor}} reference. The keys and and values of the map entries will be converted to strings, URL-encoded (see [[#web:encode-url|web:encode-url]]), and appended to the url URL as query parameters. If a map entry has more than a single item, all of them will be appended as single parameters.

|{{Error|BXWE0001invalid|#Errors}} Specified URI is the string contains invalidXML characters.|} ==web:forward== {| width='100%'

| width='120' | '''ErrorsSignatures'''|{{ErrorFunc|web:forward|$path as xs:string|element(rest:forward)}}<br/>{{Func|web:forward|$path as xs:string, $parameters as map(*)|element(rest:forward)}}|BXWE0002-|'''Summary'''|Creates a server-side [[RESTXQ#ErrorsForwards and Redirects|RESTXQ forward request]] to the specified {{Code|$path}} Specified URI contains invalid XML characters:* The client will not get notified of this forwarding.* Supplied query parameters will be attached to parameters of the current request.* The {{Code|$parameter}} argument is processed as described in [[#web:create-url|web:create-url]].|-| '''Examples'''|The function call <code><nowiki>web:forward('/a/b')</nowiki></code> creates the following result (which will be interpreted as forwarding if RESTXQ is used):<syntaxhighlight lang="xml"><rest:forward>/a/b</rest:forward></syntaxhighlight>

|{{Func|web:redirect|$location url as xs:string|element(rest:response)}}<br/>{{Func|web:redirect|$location url as xs:string, $parameters as map(item*)|element(rest:response)}}<br/>{{Func|web:redirect|$url as xs:string, item$parameters as map()*), $anchor as xs:string|element(rest:response)}}<br/>

|Creates a [[RESTXQ#Forwards and Redirects|RESTXQ redirection]] to the specified location{{Code|$url}}. The returned response will only work if no other items are returned by the RESTXQ function.<br/>If <code>The {{Code|$parameters</code> }} and {{Code|$anchor}} arguments are specified, they will be appended as query parameters to the URL processed as described for in (see [[#web:create-url|web:create-url]]).

* The query <code><nowiki>web:redirect('/a/b')</nowiki></code> returns the following result (which will be interpreted as redirection if RESTXQ is used):<pre classsyntaxhighlight lang="brush:xml">

</pre>* The first RESTXQ function creates an initial database, and redirects to a second function that will access this database:<pre class="brush:xquery">declare %updating %rest:path('/app/init') function local:init() { db:create('app', <root/>, 'root.xml'), db:output(web:redirect('/app/main'))}; declare %rest:path('/app/main') function local:update() { 'Stored documents: ' || count(db:open('app'))};</presyntaxhighlight>

|{{Func|web:response-header||element(rest:response)}}<br/>{{Func|web:response-header|$output as map(*)?|element(rest:response)}}<br/>{{Func|web:response-header|$output as map(*)?, $headers as map(xs*)?|element(rest:stringresponse)}}<br/>{{Func|web:response-header|$output as map(*)?, $headers as map(*)?, xs:string$atts as map(*)?|element(rest:response)}}<br/>

|Creates a [[RESTXQ#Response|RESTXQ response header]] with a default caching directive and default serialization parameters.<br/>Serialization parameters and header values can be supplied via the <code>$output</code> argument. Empty string values and <code>$headers</code> arguments, and status and message attributes can be specified attached to invalidate default valuesthe HTTP response element with the <code>$atts</code> argument. By default, the following serialization parameters will be returned:

* The function call <code>web:response-header()</code> returns the following response element:<pre classsyntaxhighlight lang="brush:xml">

<http:response xmlns:http="http://expath.org/ns/http-client"> <http:header name="Cache-Control" value="max-age=3600,public"/> </http:response> <output:serialization-parameters xmlns:output="http://www.w3.org/2010/xslt-xquery-serialization"> <output:media-type value="application/octet-stream"/> </output:serialization-parameters>

</presyntaxhighlight>* If The following expression returns a media-type for binary data, a caching directive, and the OK status:<br/><syntaxhighlight lang="xquery">web:response-header( map { 'media-type': 'application/octet-stream' }, map { 'Cache-Control': 'max-age=3600,public' }, map { 'status': 200, 'message': 'OK' })</syntaxhighlight>* The following RESTXQ function is called by returns the contents of a web browser…file to the client with correct media type:<br/><pre classsyntaxhighlight lang="brush:xquery">

</presyntaxhighlight>…a file resource |} ==web:error== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|web:error|$status as xs:integer, $message as xs:string|none}}<br/>|-| '''Summary'''|Raises an error with the correct content-type will be returned QName {{Code|rest:error}}, the specified {{Code|$message}} and the specified {{Code|$status}} as error value.<br/>Calls to this function are equivalent to user <code>fn:error(xs:QName(provided that it exists 'rest:error'), $message, $status)</code>. See [[RESTXQ#Raise Errors|RESTXQ: Raise Errors]] to learn how the function is helpful in the web serverapplications.|-| '''s file systemExamples'''|* <code><nowiki>web:error(404, "The requested resource cannot be found.")</nowiki></code>|-| '''Errors'''|{{Error|status|#Errors}} The supplied status code is invalid.

|{{Code|BXWE0001invalid}}|Specified URL is A string contains invalidXML characters.

|{{Code|BXWE0002status}}|Specified URL contains The supplied status code is invalid XML characters.