dmpiniturl
dmpiniturl |
Purpose
Synopsis
procedure dmpiniturl(res:dmpresource, url:text, authtokentype:text, authtoken:text)
procedure dmpiniturl(res:dmpresource, url:text, authheaders:array(set of string) of text)
Arguments
res
|
The
dmpresource value to initialize.
|
||||
url
|
The resource root URL. All dmphttp calls through this resource will be relative to this URL.
|
||||
authtokentype
|
The type of authorization token, expressed as one of the following constants:
|
||||
authtoken
|
The authorization token to add to outgoing HTTP requests made through this resource.
|
||||
authheaders
|
A collection of HTTP Headers to add to outgoing HTTP requests made through this resource.
|
Example
declarations res: dmpresource headers: dynamic array(set of string) of text end-declarations headers("Cookie") := "SESSIONID=8364825249" headers("Authorization") := "Bearer 834692364jdnvdjfvb7t3jkd78" dmpiniturl(res, "http://fakeresource.example.com/", headers) if res.status<>DMP_OK then writeln('ERROR: ',res.lasterror) end-if
Further information
1. This procedure is intended to assist users to write code interacting with DMP resources that will work both within Xpress DMP components and when executed locally.
2. If you pass an
authtoken value, all HTTP requests made through this resource will be decorated with an appropriate
Authorization: header.
3. If you pass an
authheaders value, all HTTP requests made through this resource will be decorated with HTTP headers read from this array (indices are the header names).
4. You should check the
status attribute of the
dmpresource after calling this procedure.